Repository files navigation

Compile json schema to typescript typings

[In Beta]: Bug reports appreciated!

Input:

{"title":"Example Schema","type":"object","properties": {"firstName": {"type":"string"    },"lastName": {"type":"string"    },"age": {"description":"Age in years","type":"integer","minimum":0    },"hairColor": {"enum": ["black","brown","blue"],"type":"string"    }  },"required": ["firstName","lastName"]}

Output:

exportinterfaceExampleSchema{firstName:string;lastName:string;/**   * Age in years   */age?:number;hairColor?:"black"|"brown"|"blue";}

npm install json-schema-to-typescript

import{compileFromFile}from'json-schema-to-typescript'fs.writeFileSync('dist/foo.d.ts',awaitcompileFromFile('src/foo.json'))

See/example for a fully working demo.

Simple CLI utility is provided within the package.

cat foo.json | json2ts > foo.d.ts# orjson2ts foo.json# orjson2ts foo.json foo.d.ts# orjson2ts --input foo.json --output foo.d.ts# orjson2ts -i foo.json -o foo.d.ts

In case you don't specify output path, results are saved in input directory in.d.ts file.

npm test

• title =>interface
• Primitive types:
  • array
  • homogeneous array
  • boolean
  • integer
  • number
  • null
  • object
  • string
  • homogeneous enum
  • heterogeneous enum
• Non/extensible interfaces
• Custom JSON-schema extensions
• Nested properties
• Schema definitions
• Schema references
• Local (filesystem) schema references
• External (network) schema references
• Add support for running in browser
• default interface name
• infer unnamed interface name from filename
• anyOf ("union")
• allOf ("intersection")
• additionalProperties of type
• extends
• required properties on objects (eg)
• validateRequired (eg)
• literal objects in enum (eg)
• referencing schema by id (eg)
• clean up + refactor code

• dependencies (single,multiple)
• divisibleBy (eg)
• format (eg)
• multipleOf (eg)
• maximum (eg)
• minimum (eg)
• maxItems (eg)
• minItems (eg)
• maxProperties (eg)
• minProperties (eg)
• not/disallow
• oneOf ("xor", useanyOf instead)
• pattern (string,regex)
• patternProperties (eg)
• uniqueItems (eg)

• JSON-schema spec:http://json-schema.org/latest/json-schema-core.html
• JSON-schema wiki:https://github.com/json-schema/json-schema/wiki
• JSON-schema test suite:https://github.com/json-schema/JSON-Schema-Test-Suite/blob/node
• TypeScript spec:https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md