fosfad / json-schema-typescript-definitions

Types and interfaces for writing valid JSON schema in TypeScript.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.

About

Types and interfaces for writing valid JSON schema in TypeScript.

License:MIT License


Languages

Language:TypeScript 100.0%