/mod.ts | spartanschema@v1.1.1

import * as spartanschema from "https://deno.land/x/spartanschema@v1.1.1/mod.ts";

Classes

SchemaAssertionError

A detailed error thrown by assertMatchesSchema when schema validation fails. Includes the schema, the JSON that didn't match, and the list of validation errors, complete with JSONPath locations in both the schema and the JSON value.

Functions

f assertMatchesSchema	A curried function that checks whether `value` matches `schema` and throws a `SchemaAssertionError` if it doesn't.
f isSchema	A type predicate that checks whether `schema` is a valid Spartan Schema.
f matchesSchema	A curried function that checks whether `value` matches `schema` and returns a boolean.
f pathToString	Returns a parseable string representation of a `Path`, in JSONPath format.
f validationErrorToString
f zeroValue	Returns the zero value of this schema's root type.

Interfaces

I Schema	The type of valid Spartan Schemas.
I SchemaError
I ValidationError

Type Aliases

T MatchesSchema	Given a type `S` that describes the exact shape of a `Schema`, `MatchesSchema<S>` is the type of values that match that schema.
T MatchesSchemaType
T Path	A more general type than `PathArray`, for any iterable value that can describe a specific location in a JSON document.
T PathArray	A path to a specific location in a JSON document.
T SchemaType