You've already forked Epicnabbo-Catalogus-Updated-Daily
Remco
66 lines
2.2 KiB
TypeScript
66 lines
2.2 KiB
TypeScript
export type JSONSchema4 = import("json-schema").JSONSchema4;
|
|
export type JSONSchema6 = import("json-schema").JSONSchema6;
|
|
export type JSONSchema7 = import("json-schema").JSONSchema7;
|
|
export type ErrorObject = import("ajv").ErrorObject;
|
|
export type Extend = {
|
|
formatMinimum?: number | undefined;
|
|
formatMaximum?: number | undefined;
|
|
formatExclusiveMinimum?: boolean | undefined;
|
|
formatExclusiveMaximum?: boolean | undefined;
|
|
link?: string | undefined;
|
|
undefinedAsNull?: boolean | undefined;
|
|
};
|
|
export type Schema = (JSONSchema4 | JSONSchema6 | JSONSchema7) & Extend;
|
|
export type SchemaUtilErrorObject = ErrorObject & {
|
|
children?: Array<ErrorObject>;
|
|
};
|
|
export type PostFormatter = (
|
|
formattedError: string,
|
|
error: SchemaUtilErrorObject
|
|
) => string;
|
|
export type ValidationErrorConfiguration = {
|
|
name?: string | undefined;
|
|
baseDataPath?: string | undefined;
|
|
postFormatter?: PostFormatter | undefined;
|
|
};
|
|
/** @typedef {import("json-schema").JSONSchema4} JSONSchema4 */
|
|
/** @typedef {import("json-schema").JSONSchema6} JSONSchema6 */
|
|
/** @typedef {import("json-schema").JSONSchema7} JSONSchema7 */
|
|
/** @typedef {import("ajv").ErrorObject} ErrorObject */
|
|
/**
|
|
* @typedef {Object} Extend
|
|
* @property {number=} formatMinimum
|
|
* @property {number=} formatMaximum
|
|
* @property {boolean=} formatExclusiveMinimum
|
|
* @property {boolean=} formatExclusiveMaximum
|
|
* @property {string=} link
|
|
* @property {boolean=} undefinedAsNull
|
|
*/
|
|
/** @typedef {(JSONSchema4 | JSONSchema6 | JSONSchema7) & Extend} Schema */
|
|
/** @typedef {ErrorObject & { children?: Array<ErrorObject>}} SchemaUtilErrorObject */
|
|
/**
|
|
* @callback PostFormatter
|
|
* @param {string} formattedError
|
|
* @param {SchemaUtilErrorObject} error
|
|
* @returns {string}
|
|
*/
|
|
/**
|
|
* @typedef {Object} ValidationErrorConfiguration
|
|
* @property {string=} name
|
|
* @property {string=} baseDataPath
|
|
* @property {PostFormatter=} postFormatter
|
|
*/
|
|
/**
|
|
* @param {Schema} schema
|
|
* @param {Array<object> | object} options
|
|
* @param {ValidationErrorConfiguration=} configuration
|
|
* @returns {void}
|
|
*/
|
|
export function validate(
|
|
schema: Schema,
|
|
options: Array<object> | object,
|
|
configuration?: ValidationErrorConfiguration | undefined
|
|
): void;
|
|
import ValidationError from "./ValidationError";
|
|
export { ValidationError };
|