json-schema-to-typescript

What is json-schema-to-typescript?

The json-schema-to-typescript npm package is a tool that converts JSON Schema definitions into TypeScript interfaces. This is particularly useful for ensuring type safety in TypeScript projects by generating types directly from JSON Schema, which can help in maintaining consistency between your data models and TypeScript types.

Convert JSON Schema to TypeScript Interface

This feature allows you to convert a JSON Schema into a TypeScript interface. The `compile` function takes a JSON Schema and a name for the resulting TypeScript interface, and returns a promise that resolves to the TypeScript code as a string.

const { compile } = require('json-schema-to-typescript');

const schema = {
  title: 'Example Schema',
  type: 'object',
  properties: {
    name: { type: 'string' },
    age: { type: 'number' }
  },
  required: ['name', 'age']
};

compile(schema, 'ExampleSchema')
  .then(ts => console.log(ts));

Generate TypeScript Definitions from Multiple Schemas

This feature allows you to generate TypeScript definitions from a JSON Schema file. The `compileFromFile` function reads a JSON Schema from a file and returns a promise that resolves to the TypeScript code as a string.

const { compileFromFile } = require('json-schema-to-typescript');

compileFromFile('path/to/schema.json')
  .then(ts => console.log(ts));

Customizing Output

This feature allows you to customize the output of the TypeScript definitions. The `compile` function accepts an options object where you can specify various settings like adding a banner comment to the generated TypeScript code.

const { compile } = require('json-schema-to-typescript');

const schema = {
  title: 'Example Schema',
  type: 'object',
  properties: {
    name: { type: 'string' },
    age: { type: 'number' }
  },
  required: ['name', 'age']
};

const options = {
  bannerComment: '/* This is a generated file */'
};

compile(schema, 'ExampleSchema', options)
  .then(ts => console.log(ts));

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 `$ref`s
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 `$ref`s

What is json-schema-to-typescript?

What are json-schema-to-typescript's main functionalities?

Other packages similar to json-schema-to-typescript