@types/json-schema

What is @types/json-schema?

The @types/json-schema package provides TypeScript type definitions for JSON Schema. It allows developers to use JSON Schema in TypeScript projects with type checking, enabling them to define valid JSON structures more accurately and with the benefits of autocompletion and compile-time validation. This package does not include functionality to validate JSON data against schemas but rather provides types to assist in writing code that can create, manipulate, or understand JSON Schemas.

What are @types/json-schema's main functionalities?

Defining a JSON Schema

This code sample demonstrates how to define a simple JSON Schema for an object with required 'name' (string) and 'age' (number) properties using TypeScript. The @types/json-schema package provides types that make it easier to define such schemas with the benefits of type checking.

{"$schema": "http://json-schema.org/draft-07/schema#","type": "object","properties": {"name": {"type": "string"},"age": {"type": "number"}},"required": ["name", "age"]}

Using JSON Schema with TypeScript interfaces

This example shows how to define a TypeScript interface and a corresponding JSON Schema. The @types/json-schema package allows the use of JSONSchema7 (or other version-specific types) to ensure the schema definition is type-safe.

interface Person {name: string; age: number;}; const personSchema: JSONSchema7 = {type: 'object', properties: {name: {type: 'string'}, age: {type: 'number'}}, required: ['name', 'age']};

Other packages similar to @types/json-schema

ajv

Ajv is a JSON schema validator that compiles schemas to functions and validates data against them. It is significantly different from @types/json-schema as Ajv focuses on validation rather than providing TypeScript types. However, it supports JSON Schema draft-06/07/2019-09 and can be used alongside type definitions for runtime validation.

jsonschema

The jsonschema package is a JSON Schema validator that can validate JavaScript objects using JSON Schemas. Unlike @types/json-schema, which provides TypeScript types for schema definitions, jsonschema focuses on the validation aspect, checking if objects match the schemas.

README

Installation

npm install --save @types/json-schema

Summary

This package contains type definitions for json-schema 4.0, 6.0 and (https://github.com/kriszyp/json-schema).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/json-schema.

Additional Details

• Last updated: Tue, 06 Jul 2021 21:33:48 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Boris Cherny, Cyrille Tuzi, Lucian Buzzo, Roland Groza, and Jason Kwok.