bcherny/json-schema-to-typescript

`"instanceof": "Function"` inside "anyOf" getting converted to `[k: string]: any`

Open

#164 opened on May 8, 2018

View on GitHub
 (3 comments) (0 reactions) (1 assignee)TypeScript (449 forks)github user discovery
blockedenhancementhelp wanted

Repository metrics

Stars
 (3,302 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Before:

   {
    "target": {
      "description": "Environment to build for",
      "anyOf": [
        {
          "enum": [
            "web",
            "webworker",
            "node",
            "async-node",
            "node-webkit",
            "electron-main",
            "electron-renderer"
          ]
        },
        {
          "instanceof": "Function"
        }
      ]
    },
  }

converts (i believe improperly to):

	/**
	 * Environment to build for
	 */
	target?:
		| (
				| "web"
				| "webworker"
				| "node"
				| "async-node"
				| "node-webkit"
				| "electron-main"
				| "electron-renderer")
		| {
				[k: string]: any;
		  };

I identified this throughout this PR for webpack/webpack#7232

Contributor guide

Research direction
Investigate the logic that converts anyOf schemas with instanceof to TypeScript types; specifically trace the path when encountering 'instanceof': 'Function' inside an anyOf array and ensure it outputs a function type instead of an index signature.
Tech stack
typescript
Domain
developer experiencetooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptJSON Schema
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70