JSON Schema is a useful way to define input and output schemas.
Typescript is a useful way to verify the types of JavaScript objects.
json-schema-strictly-typed implements a strict flavor of the JSON Schema 7 specification for typing. By strict, we mean that it is organized into logical types that represent real usage, disallowing certain "nonsense" combinations of fields.
import { JSSTInteger } from "json-schema-strictly-typed";
test("my schema is an integer", () => {
JSSTInteger.is({ type: "integer" });
});Here are all of the types in the API. Some of them also have sub-types for useful validation. In addition to canonical JSON Schema 6, we have added an optional faker field to the string type to use faker-like packages.
JSSTEmptyJSSTConstJSSTReferenceJSSTNullJSSTBooleanJSSTIntegerJSSTSimpleIntegerJSSTIntegerWithMinimumJSSTIntegerWithMaximumJSSTIntegerWithBoundsJSSTIntegerWithNumericExclusiveBoundsJSSTIntegerWithNumericExclusiveMaximumJSSTIntegerWithNumericExclusiveMinimumJSSTIntegerEnum
JSSTNumberJSSTSimpleNumberJSSTNumberEnum
JSSTStringJSSTSimpleStringJSSTRegexJSSTStringEnum
JSSTArrayJSSTListJSSTTuple
JSSTObjectJSSTOneOfJSSTAnyOfJSSTAllOfJSSTNot
Additionally, top-level versions of all of these are available by adding TopLevel to the definition. Top-level JSON Schema objects contain optional fields like $id, $schema and definitions.
Thanks for wanting to contribute! We will soon have a contributing page detaling how to contribute. Meanwhile, there are plenty of features that haven't been implemented yet. Please check out our open issues. We'd really appreciate your help!
Please note that this project is governed by the Meeshkan Community Code of Conduct. By participating in this project, you agree to abide by its terms.