@squiz/json-schema-library/dist/lib/validateAsync.d.ts

Customizable and hackable json-validator and json-schema utilities for traversal, data generation and validation

import { JSONSchema, JSONPointer, JSONError } from "./types";
import { Draft as Core } from "./draft";
export interface OnError {
    (error: JSONError): void;
}
export type Options = {
    schema?: JSONSchema;
    pointer?: JSONPointer;
    onError?: OnError;
};
/**
 * @async
 * Validate data by a json schema
 *
 * @param core - validator
 * @param value - value to validate
 * @param options
 * @param options.schema - json schema to use, defaults to core.rootSchema
 * @param options.pointer - json pointer pointing to current value. Used in error reports
 * @param options.onError   - will be called for each error as soon as it is resolved
 * @return list of errors or empty
 */
export default function validateAsync(core: Core, value: any, options?: Options): Promise<Array<JSONError>>;