@squiz/json-schema-library
Version:
Customizable and hackable json-validator and json-schema utilities for traversal, data generation and validation
27 lines (26 loc) • 809 B
TypeScript
import { Draft as Core } from "./draft";
export type JSONSchema = {
[p: string]: any;
};
export type JSONPointer = string;
export type JSONError = {
type: "error";
name: string;
code: string;
message: string;
data?: {
[p: string]: any;
};
[p: string]: any;
};
/**
* ts type guard for json error
* @returns true if passed type is a JSONError
*/
export declare function isJSONError(error: any): error is JSONError;
export interface JSONValidator {
(core: Core, schema: JSONSchema, value: unknown, pointer: JSONPointer): void | undefined | JSONError | JSONError[] | JSONError[][];
}
export interface JSONTypeValidator {
(core: Core, schema: JSONSchema, value: unknown, pointer: JSONPointer): Array<void | undefined | JSONError | JSONError[] | JSONError[][]>;
}