Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 972 Bytes

README.md

File metadata and controls

31 lines (19 loc) · 972 Bytes
Raw

JSON Schema TypeScript definitions

This package contains TypeScript definitions for JSON Schema. It may be useful in all kind of TypeScript projects that work with JSON Schema directly.

Supported JSON Schema drafts:

Getting started

Install the definitions:

npm install @fosfad/json-schema-typescript-definitions

Import JsonSchema type definition:

import { JsonSchema } from '@fosfad/json-schema-typescript-definitions/2020-12';

Documentation

Exported types

The package exports 3 types: JsonSchemaBoolean, JsonSchemaObject and JsonSchema:

  • JsonSchemaBoolean stands for Boolean JSON Schema;
  • JsonSchemaObject is an object with all possible JSON Schema keywords within;
  • JsonSchema is a union type between JsonSchemaBoolean and JsonSchemaObject.