@codethread/tstl-validate
Version:
Fork and adaptation of valibot for use in typescript-to-lua
24 lines (23 loc) • 741 B
TypeScript
/** @noSelfInFile */
import { type Issues, ValiError } from '../../error/index';
import type { BaseSchema, BaseSchemaAsync, Output, ParseInfo } from '../../types';
/**
* Parses unknown input based on a schema.
*
* @param schema The schema to be used.
* @param input The input to be parsed.
* @param info The optional parse info.
*
* @returns The parsed output.
*/
export declare function safeParseAsync<TSchema extends BaseSchema | BaseSchemaAsync>(schema: TSchema, input: unknown, info?: Pick<ParseInfo, 'abortEarly' | 'abortPipeEarly'>): Promise<{
success: true;
data: Output<TSchema>;
} | {
success: false;
/**
* @deprecated Please use `.issues` instead.
*/
error: ValiError;
issues: Issues;
}>;