@codethread/tstl-validate
Version:
Fork and adaptation of valibot for use in typescript-to-lua
41 lines (40 loc) • 921 B
TypeScript
/** @noSelfInFile */
import type { PathItem } from "../../types";
/**
* Issue reason type.
*/
export type IssueReason = "type" | "string" | "number" | "boolean" | "any" | "unknown" | "array" | "tuple" | "object" | "record" | "special" | "instance";
/**
* Issue origin type.
*/
export type IssueOrigin = "key" | "value";
/**
* Issue type.
*/
export type Issue = {
reason: IssueReason;
validation: string;
origin: IssueOrigin;
message: string;
input: any;
path?: PathItem[];
issues?: Issues;
abortEarly?: boolean;
abortPipeEarly?: boolean;
};
/**
* Issues type.
*/
export type Issues = [Issue, ...Issue[]];
/**
* A Valibot error with useful information.
*/
export declare class ValiError extends Error {
issues: Issues;
/**
* Creates a Valibot error with useful information.
*
* @param issues The error issues.
*/
constructor(issues: Issues);
}