json-schema-to-typescript

Compile JSON Schema to TypeScript typings.

Example

Check out the live demo.

Input:

1{
2  "title": "Example Schema",
3  "type": "object",
4  "properties": {
5    "firstName": {
6      "type": "string"
7    },
8    "lastName": {
9      "type": "string"
10    },
11    "age": {
12      "description": "Age in years",
13      "type": "integer",
14      "minimum": 0
15    },
16    "hairColor": {
17      "enum": ["black", "brown", "blue"],
18      "type": "string"
19    }
20  },
21  "additionalProperties": false,
22  "required": ["firstName", "lastName"]
23}

Output:

1export interface ExampleSchema {
2  firstName: string;
3  lastName: string;
4  /**
5   * Age in years
6   */
7  age?: number;
8  hairColor?: "black" | "brown" | "blue";
9}

Installation

1npm install json-schema-to-typescript

Usage

json-schema-to-typescript is easy to use via the CLI, or programmatically.

CLI

First make the CLI available using one of the following options:

1# install locally, then use `npx json2ts`
2npm install json-schema-to-typescript
3
4# or install globally, then use `json2ts`
5npm install json-schema-to-typescript --global
6
7# or install to npm cache, then use `npx --package=json-schema-to-typescript json2ts`
8# (you don't need to run an install command first)

Then, use the CLI to convert JSON files to TypeScript typings:

1cat foo.json | json2ts > foo.d.ts
2# or
3json2ts foo.json > foo.d.ts
4# or
5json2ts foo.yaml foo.d.ts
6# or
7json2ts --input foo.json --output foo.d.ts
8# or
9json2ts -i foo.json -o foo.d.ts
10# or (quote globs so that your shell doesn't expand them)
11json2ts -i 'schemas/**/*.json'
12# or
13json2ts -i schemas/ -o types/

You can pass any of the options described below (including style options) as CLI flags. Boolean values can be set to false using the no- prefix.

1# generate code for definitions that aren't referenced
2json2ts -i foo.json -o foo.d.ts --unreachableDefinitions
3# use single quotes and disable trailing semicolons
4json2ts -i foo.json -o foo.d.ts --style.singleQuote --no-style.semi

API

To invoke json-schema-to-typescript from your TypeScript or JavaScript program, import it and call compile or compileFromFile.

1import { compile, compileFromFile } from 'json-schema-to-typescript'
2
3// compile from file
4compileFromFile('foo.json')
5  .then(ts => fs.writeFileSync('foo.d.ts', ts))
6
7// or, compile a JS object
8let mySchema = {
9  properties: [...]
10}
11compile(mySchema, 'MySchema')
12  .then(ts => ...)

See server demo and browser demo for full examples.

Options

compileFromFile and compile accept options as their last argument (all keys are optional):

key	type	default	description
additionalProperties	boolean	true	Default value for additionalProperties, when it is not explicitly set
bannerComment	string	"/* eslint-disable */\n/**\n* This file was automatically generated by json-schema-to-typescript.\n* DO NOT MODIFY IT BY HAND. Instead, modify the source JSON Schema file,\n* and run json-schema-to-typescript to regenerate this file.\n*/"	Disclaimer comment prepended to the top of each generated file
customName	(LinkedJSONSchema, string | undefined) => string | undefined	undefined	Custom function to provide a type name for a given schema
cwd	string	process.cwd()	Root directory for resolving $refs
declareExternallyReferenced	boolean	true	Declare external schemas referenced via $ref?
enableConstEnums	boolean	true	Prepend enums with const?
inferStringEnumKeysFromValues	boolean	false	Create enums from JSON enums with eponymous keys
format	boolean	true	Format code? Set this to false to improve performance.
ignoreMinAndMaxItems	boolean	false	Ignore maxItems and minItems for array types, preventing tuples being generated.
maxItems	number	20	Maximum number of unioned tuples to emit when representing bounded-size array types, before falling back to emitting unbounded arrays. Increase this to improve precision of emitted types, decrease it to improve performance, or set it to -1 to ignore maxItems.
strictIndexSignatures	boolean	false	Append all index signatures with | undefined so that they are strictly typed.
style	object	{ bracketSpacing: false, printWidth: 120, semi: true, singleQuote: false, tabWidth: 2, trailingComma: 'none', useTabs: false }	A Prettier configuration
unknownAny	boolean	true	Use unknown instead of any where possible
unreachableDefinitions	boolean	false	Generates code for $defs that aren't referenced by the schema.
$refOptions	object	{}	$RefParser Options, used when resolving $refs

Tests

1$ npm test

Features

• 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
• deprecated
• allOf ("intersection")
• anyOf ("union")
• oneOf (treated like anyOf)
• maxItems (eg)
• minItems (eg)
• additionalProperties of type
• patternProperties (partial support)
• extends
• required properties on objects (eg)
• validateRequired (eg)
• literal objects in enum (eg)
• referencing schema by id (eg)
• custom typescript types via tsType

Custom schema properties:

• tsType: Overrides the type that's generated from the schema. Useful for forcing a type to any or when using non-standard JSON schema extensions (eg).
• tsEnumNames: Overrides the names used for the elements in an enum. Can also be used to create string enums (eg).

Not expressible in TypeScript:

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

FAQ

JSON-Schema-to-TypeScript is crashing on my giant file. What can I do?

Prettier is known to run slowly on really big files. To skip formatting and improve performance, set the format option to false.

Further Reading

• JSON-schema spec: https://tools.ietf.org/html/draft-zyp-json-schema-04
• 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

Who uses JSON-Schema-to-TypeScript?

• Alibaba
• Amazon, AWSLabs
• Expo
• FormatJS
• Microsoft
• Mozilla
• Nx
• RStudio
• Sourcegraph
• Stryker
• Webpack
• See more