//#region src/methods/assert/assert.d.ts /** * Checks if the input matches the schema. As this is an assertion function, it * can be used as a type guard. * * @param schema The schema to be used. * @param input The input to be tested. */ declare function assert>>(schema: TSchema, input: unknown): asserts input is InferInput; //#endregion //#region src/methods/config/config.d.ts /** * Changes the local configuration of a schema. * * @param schema The schema to configure. * @param config The parse configuration. * * @returns The configured schema. */ declare function config> | BaseSchemaAsync>>(schema: TSchema, config: Config>): TSchema; //#endregion //#region src/methods/fallback/fallback.d.ts /** * Fallback type. */ type Fallback>> = MaybeReadonly> | ((dataset?: OutputDataset, InferIssue>, config?: Config>) => MaybeReadonly>); /** * Schema with fallback type. */ type SchemaWithFallback>, TFallback$1 extends Fallback> = TSchema & { /** * The fallback value. */ readonly fallback: TFallback$1; }; /** * Returns a fallback value as output if the input does not match the schema. * * @param schema The schema to catch. * @param fallback The fallback value. * * @returns The passed schema. */ declare function fallback>, const TFallback$1 extends Fallback>(schema: TSchema, fallback: TFallback$1): SchemaWithFallback; //#endregion //#region src/methods/fallback/fallbackAsync.d.ts /** * Fallback async type. */ type FallbackAsync> | BaseSchemaAsync>> = MaybeReadonly> | ((dataset?: OutputDataset, InferIssue>, config?: Config>) => MaybePromise>>); /** * Schema with fallback async type. */ type SchemaWithFallbackAsync> | BaseSchemaAsync>, TFallback$1 extends FallbackAsync> = Omit & { /** * The fallback value. */ readonly fallback: TFallback$1; /** * Whether it's async. */ readonly async: true; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps, InferOutput>; /** * Parses unknown input values. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise, InferIssue>>; }; /** * Returns a fallback value as output if the input does not match the schema. * * @param schema The schema to catch. * @param fallback The fallback value. * * @returns The passed schema. */ declare function fallbackAsync> | BaseSchemaAsync>, const TFallback$1 extends FallbackAsync>(schema: TSchema, fallback: TFallback$1): SchemaWithFallbackAsync; //#endregion //#region src/methods/flatten/flatten.d.ts /** * Flat errors type. */ type FlatErrors> | BaseSchemaAsync> | undefined> = Prettify<{ /** * The root errors. * * Hint: The error messages of issues without a path that belong to the root * of the schema are added to this key. */ readonly root?: [string, ...string[]]; /** * The nested errors. * * Hint: The error messages of issues with a path that belong to the nested * parts of the schema and can be converted to a dot path are added to this * key. */ readonly nested?: Prettify> | BaseSchemaAsync> ? IssueDotPath : string, [string, ...string[]]>>>>; /** * The other errors. * * Hint: Some issue paths, for example for complex data types like `Set` and * `Map`, have no key or a key that cannot be converted to a dot path. These * error messages are added to this key. */ readonly other?: [string, ...string[]]; }>; /** * Flatten the error messages of issues. * * @param issues The list of issues. * * @returns A flat error object. */ declare function flatten(issues: [BaseIssue, ...BaseIssue[]]): FlatErrors; /** * Flatten the error messages of issues. * * @param issues The list of issues. * * @returns A flat error object. */ declare function flatten> | BaseSchemaAsync>>(issues: [InferIssue, ...InferIssue[]]): FlatErrors; //#endregion //#region src/methods/forward/types.d.ts /** * Extracts the exact keys of a tuple, array or object. */ type KeyOf$1 = IsAny extends true ? never : TValue$1 extends readonly unknown[] ? number extends TValue$1["length"] ? number : { [TKey in keyof TValue$1]: TKey extends `${infer TIndex extends number}` ? TIndex : never }[number] : TValue$1 extends Record ? keyof TValue$1 & (string | number) : never; /** * Path type. */ type Path$1 = readonly (string | number)[]; /** * Required path type. */ type RequiredPath$1 = readonly [string | number, ...Path$1]; /** * Lazily evaluate only the first valid path segment based on the given value. */ type LazyPath$1 = TPathToCheck extends readonly [] ? TValidPath : TPathToCheck extends readonly [infer TFirstKey extends KeyOf$1 & keyof TValue$1, ...infer TPathRest extends Path$1] ? LazyPath$1 : IsNever> extends false ? readonly [...TValidPath, KeyOf$1] : TValidPath; /** * Returns the path if valid, otherwise the first possible valid path based on * the given value. */ type ValidPath$1 | ArrayLike, TPath extends RequiredPath$1> = TPath extends LazyPath$1 ? TPath : LazyPath$1; //#endregion //#region src/methods/forward/forward.d.ts /** * Forwards the issues of the passed validation action. * * @param action The validation action. * @param path The path to forward the issues to. * * @returns The modified action. */ declare function forward | ArrayLike, TIssue extends BaseIssue, const TPath extends RequiredPath$1>(action: BaseValidation, path: ValidPath$1): BaseValidation; //#endregion //#region src/methods/forward/forwardAsync.d.ts /** * Forwards the issues of the passed validation action. * * @param action The validation action. * @param path The path to forward the issues to. * * @returns The modified action. */ declare function forwardAsync | ArrayLike, TIssue extends BaseIssue, const TPath extends RequiredPath$1>(action: BaseValidation | BaseValidationAsync, path: ValidPath$1): BaseValidationAsync; //#endregion //#region src/methods/getDefault/getDefault.d.ts /** * Schema with default type. */ type SchemaWithDefault = ExactOptionalSchema>, unknown> | NullableSchema>, unknown> | NullishSchema>, unknown> | OptionalSchema>, unknown> | UndefinedableSchema>, unknown>; /** * Schema with default async type. */ type SchemaWithDefaultAsync = ExactOptionalSchemaAsync> | BaseSchemaAsync>, unknown> | NullableSchemaAsync> | BaseSchemaAsync>, unknown> | NullishSchemaAsync> | BaseSchemaAsync>, unknown> | OptionalSchemaAsync> | BaseSchemaAsync>, unknown> | UndefinedableSchemaAsync> | BaseSchemaAsync>, unknown>; /** * Infer default type. */ type InferDefault> | BaseSchemaAsync> | SchemaWithDefault | SchemaWithDefaultAsync> = TSchema extends SchemaWithDefault | SchemaWithDefaultAsync ? TSchema["default"] extends ((...args: any) => any) ? ReturnType : TSchema["default"] : undefined; /** * Returns the default value of the schema. * * @param schema The schema to get it from. * @param dataset The input dataset if available. * @param config The config if available. * * @returns The default value. */ declare function getDefault> | BaseSchemaAsync>>(schema: TSchema, dataset?: UnknownDataset, config?: Config>): InferDefault; //#endregion //#region src/methods/getDefaults/types.d.ts /** * Infer defaults type. */ type InferDefaults> | BaseSchemaAsync>> = TSchema extends LooseObjectSchema | undefined> | ObjectSchema | undefined> | ObjectWithRestSchema>, ErrorMessage | undefined> | StrictObjectSchema | undefined> ? { -readonly [TKey in keyof TEntries]: InferDefaults } : TSchema extends LooseObjectSchemaAsync | undefined> | ObjectSchemaAsync | undefined> | ObjectWithRestSchemaAsync>, ErrorMessage | undefined> | StrictObjectSchemaAsync | undefined> ? { -readonly [TKey in keyof TEntries]: InferDefaults } : TSchema extends LooseTupleSchema | undefined> | StrictTupleSchema | undefined> | TupleSchema | undefined> | TupleWithRestSchema>, ErrorMessage | undefined> ? { -readonly [TKey in keyof TItems]: InferDefaults } : TSchema extends LooseTupleSchemaAsync | undefined> | StrictTupleSchemaAsync | undefined> | TupleSchemaAsync | undefined> | TupleWithRestSchemaAsync>, ErrorMessage | undefined> ? { -readonly [TKey in keyof TItems]: InferDefaults } : Awaited>; //#endregion //#region src/methods/getDefaults/getDefaults.d.ts /** * Returns the default values of the schema. * * Hint: The difference to `getDefault` is that for object and tuple schemas * this function recursively returns the default values of the subschemas * instead of `undefined`. * * @param schema The schema to get them from. * * @returns The default values. */ declare function getDefaults> | LooseObjectSchema | undefined> | LooseTupleSchema | undefined> | ObjectSchema | undefined> | ObjectWithRestSchema>, ErrorMessage | undefined> | StrictObjectSchema | undefined> | StrictTupleSchema | undefined> | TupleSchema | undefined> | TupleWithRestSchema>, ErrorMessage | undefined>>(schema: TSchema): InferDefaults; //#endregion //#region src/methods/getDefaults/getDefaultsAsync.d.ts /** * Returns the default values of the schema. * * Hint: The difference to `getDefault` is that for object and tuple schemas * this function recursively returns the default values of the subschemas * instead of `undefined`. * * @param schema The schema to get them from. * * @returns The default values. */ declare function getDefaultsAsync> | BaseSchemaAsync> | LooseObjectSchema | undefined> | LooseObjectSchemaAsync | undefined> | LooseTupleSchema | undefined> | LooseTupleSchemaAsync | undefined> | ObjectSchema | undefined> | ObjectSchemaAsync | undefined> | ObjectWithRestSchema>, ErrorMessage | undefined> | ObjectWithRestSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined> | StrictObjectSchema | undefined> | StrictObjectSchemaAsync | undefined> | StrictTupleSchema | undefined> | StrictTupleSchemaAsync | undefined> | TupleSchema | undefined> | TupleSchemaAsync | undefined> | TupleWithRestSchema>, ErrorMessage | undefined> | TupleWithRestSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined>>(schema: TSchema): Promise>; //#endregion //#region src/methods/getDescription/getDescription.d.ts /** * Schema type. */ type Schema$14 = BaseSchema> | BaseSchemaAsync> | SchemaWithPipe>, ...(PipeItem> | DescriptionAction)[]]> | SchemaWithPipeAsync> | BaseSchemaAsync>), ...(PipeItem> | PipeItemAsync> | DescriptionAction)[]]>; /** * Returns the description of the schema. * * If multiple descriptions are defined, the last one of the highest level is * returned. If no description is defined, `undefined` is returned. * * @param schema The schema to get the description from. * * @returns The description, if any. * * @beta */ declare function getDescription(schema: Schema$14): string | undefined; //#endregion //#region src/methods/getExamples/getExamples.d.ts /** * Schema type. */ type Schema$13 = BaseSchema> | BaseSchemaAsync> | SchemaWithPipe>, ...(PipeItem> | ExamplesAction)[]]> | SchemaWithPipeAsync> | BaseSchemaAsync>), ...(PipeItem> | PipeItemAsync> | ExamplesAction)[]]>; /** * Recursively concat type. */ type RecursiveConcat> | PipeItemAsync>)[], TCollectedExamples extends unknown[] = []> = TRootPipe extends readonly [infer TFirstItem, ...infer TPipeRest extends readonly (PipeItem> | PipeItemAsync>)[]] ? TFirstItem extends SchemaWithPipe | SchemaWithPipeAsync ? RecursiveConcat> : TFirstItem extends ExamplesAction ? RecursiveConcat : RecursiveConcat : TCollectedExamples; /** * Infer examples type. */ type InferExamples = TSchema extends SchemaWithPipe | SchemaWithPipeAsync ? Readonly> : []; /** * Returns the examples of a schema. * * If multiple examples are defined, it concatenates them using depth-first * search. If no examples are defined, an empty array is returned. * * @param schema The schema to get the examples from. * * @returns The examples, if any. * * @beta */ declare function getExamples(schema: TSchema): InferExamples; //#endregion //#region src/methods/getFallback/getFallback.d.ts /** * Infer fallback type. */ type InferFallback> | BaseSchemaAsync>> = TSchema extends SchemaWithFallback>, infer TFallback> | SchemaWithFallbackAsync> | BaseSchemaAsync>, infer TFallback> ? TFallback extends InferOutput ? TFallback : TFallback extends (() => MaybePromise>) ? ReturnType : never : undefined; /** * Returns the fallback value of the schema. * * @param schema The schema to get it from. * @param dataset The output dataset if available. * @param config The config if available. * * @returns The fallback value. */ declare function getFallback> | BaseSchemaAsync>>(schema: TSchema, dataset?: OutputDataset, InferIssue>, config?: Config>): InferFallback; //#endregion //#region src/methods/getFallbacks/types.d.ts /** * Infer fallbacks type. */ type InferFallbacks> | BaseSchemaAsync>> = TSchema extends LooseObjectSchema | undefined> | ObjectSchema | undefined> | ObjectWithRestSchema>, ErrorMessage | undefined> | StrictObjectSchema | undefined> ? { -readonly [TKey in keyof TEntries]: InferFallbacks } : TSchema extends LooseObjectSchemaAsync | undefined> | ObjectSchemaAsync | undefined> | ObjectWithRestSchemaAsync>, ErrorMessage | undefined> | StrictObjectSchemaAsync | undefined> ? { -readonly [TKey in keyof TEntries]: InferFallbacks } : TSchema extends LooseTupleSchema | undefined> | StrictTupleSchema | undefined> | TupleSchema | undefined> | TupleWithRestSchema>, ErrorMessage | undefined> ? { -readonly [TKey in keyof TItems]: InferFallbacks } : TSchema extends LooseTupleSchemaAsync | undefined> | StrictTupleSchemaAsync | undefined> | TupleSchemaAsync | undefined> | TupleWithRestSchemaAsync>, ErrorMessage | undefined> ? { -readonly [TKey in keyof TItems]: InferFallbacks } : Awaited>; //#endregion //#region src/methods/getFallbacks/getFallbacks.d.ts /** * Returns the fallback values of the schema. * * Hint: The difference to `getFallback` is that for object and tuple schemas * this function recursively returns the fallback values of the subschemas * instead of `undefined`. * * @param schema The schema to get them from. * * @returns The fallback values. */ declare function getFallbacks> | LooseObjectSchema | undefined> | LooseTupleSchema | undefined> | ObjectSchema | undefined> | ObjectWithRestSchema>, ErrorMessage | undefined> | StrictObjectSchema | undefined> | StrictTupleSchema | undefined> | TupleSchema | undefined> | TupleWithRestSchema>, ErrorMessage | undefined>>(schema: TSchema): InferFallbacks; //#endregion //#region src/methods/getFallbacks/getFallbacksAsync.d.ts /** * Returns the fallback values of the schema. * * Hint: The difference to `getFallback` is that for object and tuple schemas * this function recursively returns the fallback values of the subschemas * instead of `undefined`. * * @param schema The schema to get them from. * * @returns The fallback values. */ declare function getFallbacksAsync> | BaseSchemaAsync> | LooseObjectSchema | undefined> | LooseObjectSchemaAsync | undefined> | LooseTupleSchema | undefined> | LooseTupleSchemaAsync | undefined> | ObjectSchema | undefined> | ObjectSchemaAsync | undefined> | ObjectWithRestSchema>, ErrorMessage | undefined> | ObjectWithRestSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined> | StrictObjectSchema | undefined> | StrictObjectSchemaAsync | undefined> | StrictTupleSchema | undefined> | StrictTupleSchemaAsync | undefined> | TupleSchema | undefined> | TupleSchemaAsync | undefined> | TupleWithRestSchema>, ErrorMessage | undefined> | TupleWithRestSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined>>(schema: TSchema): Promise>; //#endregion //#region src/methods/pipe/pipe.d.ts /** * Schema with pipe type. */ type SchemaWithPipe>, ...PipeItem>[]]> = Omit, "pipe" | "~standard" | "~run" | "~types"> & { /** * The pipe items. */ readonly pipe: TPipe$1; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps>, InferOutput>>; /** * Parses unknown input values. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset>, InferIssue>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferInput>; readonly output: InferOutput>; readonly issue: InferIssue; } | undefined; }; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * @param item14 The fourteenth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue>, const TItem14 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue>, item14: TItem14 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * @param item14 The fourteenth pipe item. * @param item15 The fifteenth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue>, const TItem14 extends PipeItem, unknown, BaseIssue>, const TItem15 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue>, item14: TItem14 | PipeAction, InferOutput, InferIssue>, item15: TItem15 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * @param item14 The fourteenth pipe item. * @param item15 The fifteenth pipe item. * @param item16 The sixteenth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue>, const TItem14 extends PipeItem, unknown, BaseIssue>, const TItem15 extends PipeItem, unknown, BaseIssue>, const TItem16 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue>, item14: TItem14 | PipeAction, InferOutput, InferIssue>, item15: TItem15 | PipeAction, InferOutput, InferIssue>, item16: TItem16 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * @param item14 The fourteenth pipe item. * @param item15 The fifteenth pipe item. * @param item16 The sixteenth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue>, const TItem14 extends PipeItem, unknown, BaseIssue>, const TItem15 extends PipeItem, unknown, BaseIssue>, const TItem16 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue>, item14: TItem14 | PipeAction, InferOutput, InferIssue>, item15: TItem15 | PipeAction, InferOutput, InferIssue>, item16: TItem16 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * @param item14 The fourteenth pipe item. * @param item15 The fifteenth pipe item. * @param item16 The sixteenth pipe item. * @param item17 The seventeenth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue>, const TItem14 extends PipeItem, unknown, BaseIssue>, const TItem15 extends PipeItem, unknown, BaseIssue>, const TItem16 extends PipeItem, unknown, BaseIssue>, const TItem17 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue>, item14: TItem14 | PipeAction, InferOutput, InferIssue>, item15: TItem15 | PipeAction, InferOutput, InferIssue>, item16: TItem16 | PipeAction, InferOutput, InferIssue>, item17: TItem17 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * @param item14 The fourteenth pipe item. * @param item15 The fifteenth pipe item. * @param item16 The sixteenth pipe item. * @param item17 The seventeenth pipe item. * @param item18 The eighteenth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue>, const TItem14 extends PipeItem, unknown, BaseIssue>, const TItem15 extends PipeItem, unknown, BaseIssue>, const TItem16 extends PipeItem, unknown, BaseIssue>, const TItem17 extends PipeItem, unknown, BaseIssue>, const TItem18 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue>, item14: TItem14 | PipeAction, InferOutput, InferIssue>, item15: TItem15 | PipeAction, InferOutput, InferIssue>, item16: TItem16 | PipeAction, InferOutput, InferIssue>, item17: TItem17 | PipeAction, InferOutput, InferIssue>, item18: TItem18 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * @param item14 The fourteenth pipe item. * @param item15 The fifteenth pipe item. * @param item16 The sixteenth pipe item. * @param item17 The seventeenth pipe item. * @param item18 The eighteenth pipe item. * @param item19 The nineteenth pipe item. * * @returns A schema with a pipeline. */ declare function pipe>, const TItem1 extends PipeItem, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue>, const TItem14 extends PipeItem, unknown, BaseIssue>, const TItem15 extends PipeItem, unknown, BaseIssue>, const TItem16 extends PipeItem, unknown, BaseIssue>, const TItem17 extends PipeItem, unknown, BaseIssue>, const TItem18 extends PipeItem, unknown, BaseIssue>, const TItem19 extends PipeItem, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue>, item14: TItem14 | PipeAction, InferOutput, InferIssue>, item15: TItem15 | PipeAction, InferOutput, InferIssue>, item16: TItem16 | PipeAction, InferOutput, InferIssue>, item17: TItem17 | PipeAction, InferOutput, InferIssue>, item18: TItem18 | PipeAction, InferOutput, InferIssue>, item19: TItem19 | PipeAction, InferOutput, InferIssue>): SchemaWithPipe; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param items The pipe items. * * @returns A schema with a pipeline. */ declare function pipe>, const TItems$1 extends readonly PipeItem, InferOutput, BaseIssue>[]>(schema: TSchema, ...items: TItems$1): SchemaWithPipe; //#endregion //#region src/methods/pipe/pipeAsync.d.ts /** * Schema with pipe async type. */ type SchemaWithPipeAsync> | BaseSchemaAsync>), ...(PipeItem> | PipeItemAsync>)[]]> = Omit, "async" | "pipe" | "~standard" | "~run" | "~types"> & { /** * The pipe items. */ readonly pipe: TPipe$1; /** * Whether it's async. */ readonly async: true; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps>, InferOutput>>; /** * Parses unknown input values. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise>, InferIssue>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferInput>; readonly output: InferOutput>; readonly issue: InferIssue; } | undefined; }; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * @param item14 The fourteenth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem14 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item14: TItem14 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * @param item14 The fourteenth pipe item. * @param item15 The fifteenth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem14 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem15 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item14: TItem14 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item15: TItem15 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * @param item14 The fourteenth pipe item. * @param item15 The fifteenth pipe item. * @param item16 The sixteenth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem14 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem15 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem16 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item14: TItem14 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item15: TItem15 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item16: TItem16 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * @param item14 The fourteenth pipe item. * @param item15 The fifteenth pipe item. * @param item16 The sixteenth pipe item. * @param item17 The seventeenth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem14 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem15 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem16 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem17 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item14: TItem14 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item15: TItem15 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item16: TItem16 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item17: TItem17 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * @param item14 The fourteenth pipe item. * @param item15 The fifteenth pipe item. * @param item16 The sixteenth pipe item. * @param item17 The seventeenth pipe item. * @param item18 The eighteenth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem14 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem15 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem16 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem17 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem18 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item14: TItem14 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item15: TItem15 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item16: TItem16 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item17: TItem17 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item18: TItem18 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param item1 The first pipe item. * @param item2 The second pipe item. * @param item3 The third pipe item. * @param item4 The fourth pipe item. * @param item5 The fifth pipe item. * @param item6 The sixth pipe item. * @param item7 The seventh pipe item. * @param item8 The eighth pipe item. * @param item9 The ninth pipe item. * @param item10 The tenth pipe item. * @param item11 The eleventh pipe item. * @param item12 The twelfth pipe item. * @param item13 The thirteenth pipe item. * @param item14 The fourteenth pipe item. * @param item15 The fifteenth pipe item. * @param item16 The sixteenth pipe item. * @param item17 The seventeenth pipe item. * @param item18 The eighteenth pipe item. * @param item19 The nineteenth pipe item. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItem1 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem2 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem3 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem4 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem5 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem6 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem7 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem8 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem9 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem10 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem11 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem12 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem13 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem14 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem15 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem16 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem17 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem18 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>, const TItem19 extends PipeItem, unknown, BaseIssue> | PipeItemAsync, unknown, BaseIssue>>(schema: TSchema, item1: TItem1 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item2: TItem2 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item3: TItem3 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item4: TItem4 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item5: TItem5 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item6: TItem6 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item7: TItem7 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item8: TItem8 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item9: TItem9 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item10: TItem10 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item11: TItem11 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item12: TItem12 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item13: TItem13 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item14: TItem14 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item15: TItem15 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item16: TItem16 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item17: TItem17 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item18: TItem18 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>, item19: TItem19 | PipeAction, InferOutput, InferIssue> | PipeActionAsync, InferOutput, InferIssue>): SchemaWithPipeAsync; /** * Adds a pipeline to a schema, that can validate and transform its input. * * @param schema The root schema. * @param items The pipe items. * * @returns A schema with a pipeline. */ declare function pipeAsync> | BaseSchemaAsync>, const TItems$1 extends readonly (PipeItem, InferOutput, BaseIssue> | PipeItemAsync, InferOutput, BaseIssue>)[]>(schema: TSchema, ...items: TItems$1): SchemaWithPipeAsync; //#endregion //#region src/methods/getMetadata/getMetadata.d.ts /** * Schema type. */ type Schema$12 = BaseSchema> | BaseSchemaAsync> | SchemaWithPipe>, ...(PipeItem> | MetadataAction>)[]]> | SchemaWithPipeAsync> | BaseSchemaAsync>), ...(PipeItem> | PipeItemAsync> | MetadataAction>)[]]>; /** * Basic pipe item type. */ type BasicPipeItem = PipeItem> | PipeItemAsync> | MetadataAction>; /** * Recursive merge type. */ type RecursiveMerge$1 = {}> = TRootPipe extends readonly [infer TFirstItem, ...infer TPipeRest extends readonly BasicPipeItem[]] ? TFirstItem extends SchemaWithPipe | SchemaWithPipeAsync ? RecursiveMerge$1> : TFirstItem extends MetadataAction ? RecursiveMerge$1> : RecursiveMerge$1 : TCollectedMetadata; /** * Infer metadata type. * * @beta */ type InferMetadata = BaseSchema extends TSchema ? Record : BaseSchemaAsync extends TSchema ? Record : TSchema extends SchemaWithPipe | SchemaWithPipeAsync ? Prettify> : {}; /** * Returns the metadata of a schema. * * If multiple metadata are defined, it shallowly merges them using depth-first * search. If no metadata is defined, an empty object is returned. * * @param schema Schema to get the metadata from. * * @returns The metadata, if any. * * @beta */ declare function getMetadata(schema: TSchema): InferMetadata; //#endregion //#region src/actions/title/title.d.ts /** * Title action interface. */ interface TitleAction extends BaseMetadata { /** * The action type. */ readonly type: "title"; /** * The action reference. */ readonly reference: typeof title; /** * The title text. */ readonly title: TTitle; } /** * Creates a title metadata action. * * @param title_ The title text. * * @returns A title action. */ declare function title(title_: TTitle): TitleAction; //#endregion //#region src/methods/getTitle/getTitle.d.ts /** * Schema type. */ type Schema$11 = BaseSchema> | BaseSchemaAsync> | SchemaWithPipe>, ...(PipeItem> | TitleAction)[]]> | SchemaWithPipeAsync> | BaseSchemaAsync>), ...(PipeItem> | PipeItemAsync> | TitleAction)[]]>; /** * Returns the title of the schema. * * If multiple titles are defined, the last one of the highest level is * returned. If no title is defined, `undefined` is returned. * * @param schema The schema to get the title from. * * @returns The title, if any. * * @beta */ declare function getTitle(schema: Schema$11): string | undefined; //#endregion //#region src/methods/is/is.d.ts /** * Checks if the input matches the schema. By using a type predicate, this * function can be used as a type guard. * * @param schema The schema to be used. * @param input The input to be tested. * * @returns Whether the input matches the schema. */ declare function is>>(schema: TSchema, input: unknown): input is InferInput; //#endregion //#region src/methods/keyof/keyof.d.ts /** * Schema type. */ type Schema$10 = LooseObjectSchema | undefined> | LooseObjectSchemaAsync | undefined> | ObjectSchema | undefined> | ObjectSchemaAsync | undefined> | ObjectWithRestSchema>, ErrorMessage | undefined> | ObjectWithRestSchemaAsync>, ErrorMessage | undefined> | StrictObjectSchema | undefined> | StrictObjectSchemaAsync | undefined>; /** * Force tuple type. */ type ForceTuple = T extends [string, ...string[]] ? T : []; /** * Object keys type. */ type ObjectKeys$1 = ForceTuple>; /** * Creates a picklist schema of object keys. * * @param schema The object schema. * * @returns A picklist schema. */ declare function keyof(schema: TSchema): PicklistSchema, undefined>; /** * Creates a picklist schema of object keys. * * @param schema The object schema. * @param message The error message. * * @returns A picklist schema. */ declare function keyof | undefined>(schema: TSchema, message: TMessage): PicklistSchema, TMessage>; //#endregion //#region src/methods/message/message.d.ts /** * Changes the local message configuration of a schema. * * @param schema The schema to configure. * @param message_ The error message. * * @returns The configured schema. */ declare function message> | BaseSchemaAsync>>(schema: TSchema, message_: ErrorMessage>): TSchema; //#endregion //#region src/methods/omit/omit.d.ts /** * Schema type. */ type Schema$9 = SchemaWithoutPipe | undefined> | LooseObjectSchemaAsync | undefined> | ObjectSchema | undefined> | ObjectSchemaAsync | undefined> | ObjectWithRestSchema>, ErrorMessage | undefined> | ObjectWithRestSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined> | StrictObjectSchema | undefined> | StrictObjectSchemaAsync | undefined>>; /** * Schema with omit type. */ type SchemaWithOmit> = TSchema extends ObjectSchema | undefined> | StrictObjectSchema | undefined> ? Omit & { /** * The object entries. */ readonly entries: Omit; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps>, InferObjectOutput>>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset>, Extract, { type: TSchema["type"]; }> | InferObjectIssue>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput>; readonly output: InferObjectOutput>; readonly issue: Extract, { type: TSchema["type"]; }> | InferObjectIssue>; } | undefined; } : TSchema extends ObjectSchemaAsync | undefined> | StrictObjectSchemaAsync | undefined> ? Omit & { /** * The object entries. */ readonly entries: Omit; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps>, InferObjectOutput>>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise>, Extract, { type: TSchema["type"]; }> | InferObjectIssue>>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput>; readonly output: InferObjectOutput>; readonly issue: Extract, { type: TSchema["type"]; }> | InferObjectIssue>; } | undefined; } : TSchema extends LooseObjectSchema | undefined> ? Omit & { /** * The object entries. */ readonly entries: Omit; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: unknown; }, InferObjectInput> & { [key: string]: unknown; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset> & { [key: string]: unknown; }, Extract, { type: TSchema["type"]; }> | InferObjectIssue>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: unknown; }; readonly output: InferObjectOutput> & { [key: string]: unknown; }; readonly issue: Extract, { type: TSchema["type"]; }> | InferObjectIssue>; } | undefined; } : TSchema extends LooseObjectSchemaAsync | undefined> ? Omit & { /** * The object entries. */ readonly entries: Omit; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: unknown; }, InferObjectInput> & { [key: string]: unknown; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise> & { [key: string]: unknown; }, Extract, { type: TSchema["type"]; }> | InferObjectIssue>>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: unknown; }; readonly output: InferObjectOutput> & { [key: string]: unknown; }; readonly issue: Extract, { type: TSchema["type"]; }> | InferObjectIssue>; } | undefined; } : TSchema extends ObjectWithRestSchema>, ErrorMessage | undefined> ? Omit & { /** * The object entries. */ readonly entries: Omit; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: InferInput; }, InferObjectOutput> & { [key: string]: InferOutput; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset> & { [key: string]: InferOutput; }, Extract, { type: TSchema["type"]; }> | InferObjectIssue> | InferIssue>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: InferInput; }; readonly output: InferObjectOutput> & { [key: string]: InferOutput; }; readonly issue: Extract, { type: TSchema["type"]; }> | InferObjectIssue> | InferIssue; } | undefined; } : TSchema extends ObjectWithRestSchemaAsync>, ErrorMessage | undefined> ? Omit & { /** * The object entries. */ readonly entries: Omit; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: InferInput; }, InferObjectOutput> & { [key: string]: InferOutput; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise> & { [key: string]: InferOutput; }, Extract, { type: TSchema["type"]; }> | InferObjectIssue> | InferIssue>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: InferInput; }; readonly output: InferObjectOutput> & { [key: string]: InferOutput; }; readonly issue: Extract, { type: TSchema["type"]; }> | InferObjectIssue> | InferIssue; } | undefined; } : never; /** * Creates a modified copy of an object schema that does not contain the * selected entries. * * @param schema The schema to omit from. * @param keys The selected entries. * * @returns An object schema. */ declare function omit>(schema: TSchema, keys: TKeys): SchemaWithOmit; //#endregion //#region src/methods/parse/parse.d.ts /** * Parses an unknown input based on a schema. * * @param schema The schema to be used. * @param input The input to be parsed. * @param config The parse configuration. * * @returns The parsed input. */ declare function parse>>(schema: TSchema, input: unknown, config?: Config>): InferOutput; //#endregion //#region src/methods/parse/parseAsync.d.ts /** * Parses an unknown input based on a schema. * * @param schema The schema to be used. * @param input The input to be parsed. * @param config The parse configuration. * * @returns The parsed input. */ declare function parseAsync> | BaseSchemaAsync>>(schema: TSchema, input: unknown, config?: Config>): Promise>; //#endregion //#region src/methods/parser/parser.d.ts /** * The parser interface. */ interface Parser>, TConfig extends Config> | undefined> { /** * Parses an unknown input based on the schema. */ (input: unknown): InferOutput; /** * The schema to be used. */ readonly schema: TSchema; /** * The parser configuration. */ readonly config: TConfig; } /** * Returns a function that parses an unknown input based on a schema. * * @param schema The schema to be used. * * @returns The parser function. */ declare function parser>>(schema: TSchema): Parser; /** * Returns a function that parses an unknown input based on a schema. * * @param schema The schema to be used. * @param config The parser configuration. * * @returns The parser function. */ declare function parser>, const TConfig extends Config> | undefined>(schema: TSchema, config: TConfig): Parser; //#endregion //#region src/methods/parser/parserAsync.d.ts /** * The parser async interface. */ interface ParserAsync> | BaseSchemaAsync>, TConfig extends Config> | undefined> { /** * Parses an unknown input based on the schema. */ (input: unknown): Promise>; /** * The schema to be used. */ readonly schema: TSchema; /** * The parser configuration. */ readonly config: TConfig; } /** * Returns a function that parses an unknown input based on a schema. * * @param schema The schema to be used. * * @returns The parser function. */ declare function parserAsync> | BaseSchemaAsync>>(schema: TSchema): ParserAsync; /** * Returns a function that parses an unknown input based on a schema. * * @param schema The schema to be used. * @param config The parser configuration. * * @returns The parser function. */ declare function parserAsync> | BaseSchemaAsync>, const TConfig extends Config> | undefined>(schema: TSchema, config: TConfig): ParserAsync; //#endregion //#region src/methods/partial/partial.d.ts /** * Schema type. */ type Schema$8 = SchemaWithoutPipe | undefined> | ObjectSchema | undefined> | ObjectWithRestSchema>, ErrorMessage | undefined> | StrictObjectSchema | undefined>>; /** * Partial entries type. */ type PartialEntries$1 = { [TKey in keyof TEntries$1]: TKeys extends readonly (keyof TEntries$1)[] ? TKey extends TKeys[number] ? OptionalSchema : TEntries$1[TKey] : OptionalSchema }; /** * Schema with partial type. */ type SchemaWithPartial | undefined> = TSchema extends ObjectSchema | undefined> | StrictObjectSchema | undefined> ? Omit & { /** * The object entries. */ readonly entries: PartialEntries$1; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps>, InferObjectOutput>>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset>, InferIssue>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput>; readonly output: InferObjectOutput>; readonly issue: InferIssue; } | undefined; } : TSchema extends LooseObjectSchema | undefined> ? Omit & { /** * The object entries. */ readonly entries: PartialEntries$1; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: unknown; }, InferObjectOutput> & { [key: string]: unknown; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset> & { [key: string]: unknown; }, InferIssue>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: unknown; }; readonly output: InferObjectOutput> & { [key: string]: unknown; }; readonly issue: InferIssue; } | undefined; } : TSchema extends ObjectWithRestSchema | undefined> ? Omit & { /** * The object entries. */ readonly entries: PartialEntries$1; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: InferInput; }, InferObjectOutput> & { [key: string]: InferOutput; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset> & { [key: string]: InferOutput; }, InferIssue>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: InferInput; }; readonly output: InferObjectOutput> & { [key: string]: InferOutput; }; readonly issue: InferIssue; } | undefined; } : never; /** * Creates a modified copy of an object schema that marks all entries as optional. * * @param schema The schema to modify. * * @returns An object schema. */ declare function partial(schema: TSchema): SchemaWithPartial; /** * Creates a modified copy of an object schema that marks the selected entries * as optional. * * @param schema The schema to modify. * @param keys The selected entries. * * @returns An object schema. */ declare function partial>(schema: TSchema, keys: TKeys): SchemaWithPartial; //#endregion //#region src/methods/partial/partialAsync.d.ts /** * Schema type. */ type Schema$7 = SchemaWithoutPipe | undefined> | ObjectSchemaAsync | undefined> | ObjectWithRestSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined> | StrictObjectSchemaAsync | undefined>>; /** * Partial entries type. */ type PartialEntries = { [TKey in keyof TEntries$1]: TKeys extends readonly (keyof TEntries$1)[] ? TKey extends TKeys[number] ? OptionalSchemaAsync : TEntries$1[TKey] : OptionalSchemaAsync }; /** * Schema with partial type. */ type SchemaWithPartialAsync | undefined> = TSchema extends ObjectSchemaAsync | undefined> | StrictObjectSchemaAsync | undefined> ? Omit & { /** * The object entries. */ readonly entries: PartialEntries; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps>, InferObjectOutput>>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise>, InferIssue>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput>; readonly output: InferObjectOutput>; readonly issue: InferIssue; } | undefined; } : TSchema extends LooseObjectSchemaAsync | undefined> ? Omit & { /** * The object entries. */ readonly entries: PartialEntries; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: unknown; }, InferObjectOutput> & { [key: string]: unknown; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise> & { [key: string]: unknown; }, InferIssue>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: unknown; }; readonly output: InferObjectOutput> & { [key: string]: unknown; }; readonly issue: InferIssue; } | undefined; } : TSchema extends ObjectWithRestSchemaAsync | undefined> ? Omit & { /** * The object entries. */ readonly entries: PartialEntries; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: InferInput; }, InferObjectOutput> & { [key: string]: InferOutput; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise> & { [key: string]: InferOutput; }, InferIssue>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: InferInput; }; readonly output: InferObjectOutput> & { [key: string]: InferOutput; }; readonly issue: InferIssue; } | undefined; } : never; /** * Creates a modified copy of an object schema that marks all entries as optional. * * @param schema The schema to modify. * * @returns An object schema. */ declare function partialAsync(schema: TSchema): SchemaWithPartialAsync; /** * Creates a modified copy of an object schema that marks the selected entries * as optional. * * @param schema The schema to modify. * @param keys The selected entries. * * @returns An object schema. */ declare function partialAsync>(schema: TSchema, keys: TKeys): SchemaWithPartialAsync; //#endregion //#region src/methods/pick/pick.d.ts /** * The schema type. */ type Schema$6 = SchemaWithoutPipe | undefined> | LooseObjectSchemaAsync | undefined> | ObjectSchema | undefined> | ObjectSchemaAsync | undefined> | ObjectWithRestSchema>, ErrorMessage | undefined> | ObjectWithRestSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined> | StrictObjectSchema | undefined> | StrictObjectSchemaAsync | undefined>>; /** * Schema with pick type. */ type SchemaWithPick> = TSchema extends ObjectSchema | undefined> | StrictObjectSchema | undefined> ? Omit & { /** * The object entries. */ readonly entries: Pick; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps>, InferObjectOutput>>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset>, Extract, { type: TSchema["type"]; }> | InferObjectIssue>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput>; readonly output: InferObjectOutput>; readonly issue: Extract, { type: TSchema["type"]; }> | InferObjectIssue>; } | undefined; } : TSchema extends ObjectSchemaAsync | undefined> | StrictObjectSchemaAsync | undefined> ? Omit & { /** * The object entries. */ readonly entries: Pick; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps>, InferObjectOutput>>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise>, Extract, { type: TSchema["type"]; }> | InferObjectIssue>>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput>; readonly output: InferObjectOutput>; readonly issue: Extract, { type: TSchema["type"]; }> | InferObjectIssue>; } | undefined; } : TSchema extends LooseObjectSchema | undefined> ? Omit & { /** * The object entries. */ readonly entries: Pick; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: unknown; }, InferObjectOutput> & { [key: string]: unknown; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset> & { [key: string]: unknown; }, Extract, { type: TSchema["type"]; }> | InferObjectIssue>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: unknown; }; readonly output: InferObjectOutput> & { [key: string]: unknown; }; readonly issue: Extract, { type: TSchema["type"]; }> | InferObjectIssue>; } | undefined; } : TSchema extends LooseObjectSchemaAsync | undefined> ? Omit & { /** * The object entries. */ readonly entries: Pick; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: unknown; }, InferObjectOutput> & { [key: string]: unknown; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise> & { [key: string]: unknown; }, Extract, { type: TSchema["type"]; }> | InferObjectIssue>>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: unknown; }; readonly output: InferObjectOutput> & { [key: string]: unknown; }; readonly issue: Extract, { type: TSchema["type"]; }> | InferObjectIssue>; } | undefined; } : TSchema extends ObjectWithRestSchema>, ErrorMessage | undefined> ? Omit & { /** * The object entries. */ readonly entries: Pick; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: InferInput; }, InferObjectOutput> & { [key: string]: InferOutput; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset> & { [key: string]: InferOutput; }, Extract, { type: TSchema["type"]; }> | InferObjectIssue> | InferIssue>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: InferInput; }; readonly output: InferObjectOutput> & { [key: string]: InferOutput; }; readonly issue: Extract, { type: TSchema["type"]; }> | InferObjectIssue> | InferIssue; } | undefined; } : TSchema extends ObjectWithRestSchemaAsync>, ErrorMessage | undefined> ? Omit & { /** * The object entries. */ readonly entries: Pick; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: InferInput; }, InferObjectOutput> & { [key: string]: InferOutput; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise> & { [key: string]: InferOutput; }, Extract, { type: TSchema["type"]; }> | InferObjectIssue> | InferIssue>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: InferInput; }; readonly output: InferObjectOutput> & { [key: string]: InferOutput; }; readonly issue: Extract, { type: TSchema["type"]; }> | InferObjectIssue> | InferIssue; } | undefined; } : never; /** * Creates a modified copy of an object schema that contains only the selected * entries. * * @param schema The schema to pick from. * @param keys The selected entries. * * @returns An object schema. */ declare function pick>(schema: TSchema, keys: TKeys): SchemaWithPick; //#endregion //#region src/methods/required/required.d.ts /** * Schema type. */ type Schema$5 = SchemaWithoutPipe | undefined> | ObjectSchema | undefined> | ObjectWithRestSchema>, ErrorMessage | undefined> | StrictObjectSchema | undefined>>; /** * Required entries type. */ type RequiredEntries$1 | undefined> = { [TKey in keyof TEntries$1]: TKeys extends readonly (keyof TEntries$1)[] ? TKey extends TKeys[number] ? NonOptionalSchema : TEntries$1[TKey] : NonOptionalSchema }; /** * Schema with required type. */ type SchemaWithRequired | undefined, TMessage extends ErrorMessage | undefined> = TSchema extends ObjectSchema | undefined> | StrictObjectSchema | undefined> ? Omit & { /** * The object entries. */ readonly entries: RequiredEntries$1; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps>, InferObjectOutput>>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset>, NonOptionalIssue | InferIssue>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput>; readonly output: InferObjectOutput>; readonly issue: NonOptionalIssue | InferIssue; } | undefined; } : TSchema extends LooseObjectSchema | undefined> ? Omit & { /** * The object entries. */ readonly entries: RequiredEntries$1; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: unknown; }, InferObjectOutput> & { [key: string]: unknown; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset> & { [key: string]: unknown; }, NonOptionalIssue | InferIssue>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: unknown; }; readonly output: InferObjectOutput> & { [key: string]: unknown; }; readonly issue: NonOptionalIssue | InferIssue; } | undefined; } : TSchema extends ObjectWithRestSchema | undefined> ? Omit & { /** * The object entries. */ readonly entries: RequiredEntries$1; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: InferInput; }, InferObjectOutput> & { [key: string]: InferOutput; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset> & { [key: string]: InferOutput; }, NonOptionalIssue | InferIssue>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: InferInput; }; readonly output: InferObjectOutput> & { [key: string]: InferOutput; }; readonly issue: NonOptionalIssue | InferIssue; } | undefined; } : never; /** * Creates a modified copy of an object schema that marks all entries as required. * * @param schema The schema to modify. * * @returns An object schema. */ declare function required(schema: TSchema): SchemaWithRequired; /** * Creates a modified copy of an object schema that marks all entries as required. * * @param schema The schema to modify. * @param message The error message. * * @returns An object schema. */ declare function required | undefined>(schema: TSchema, message: TMessage): SchemaWithRequired; /** * Creates a modified copy of an object schema that marks the selected entries * as required. * * @param schema The schema to modify. * @param keys The selected entries. * * @returns An object schema. */ declare function required>(schema: TSchema, keys: TKeys): SchemaWithRequired; /** * Creates a modified copy of an object schema that marks the selected entries * as required. * * @param schema The schema to modify. * @param keys The selected entries. * @param message The error message. * * @returns An object schema. */ declare function required, const TMessage extends ErrorMessage | undefined>(schema: TSchema, keys: TKeys, message: TMessage): SchemaWithRequired; //#endregion //#region src/methods/required/requiredAsync.d.ts /** * Schema type. */ type Schema$4 = SchemaWithoutPipe | undefined> | ObjectSchemaAsync | undefined> | ObjectWithRestSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined> | StrictObjectSchemaAsync | undefined>>; /** * Required entries type. */ type RequiredEntries | undefined> = { [TKey in keyof TEntries$1]: TKeys extends readonly (keyof TEntries$1)[] ? TKey extends TKeys[number] ? NonOptionalSchemaAsync : TEntries$1[TKey] : NonOptionalSchemaAsync }; /** * Schema with required type. */ type SchemaWithRequiredAsync | undefined, TMessage extends ErrorMessage | undefined> = TSchema extends ObjectSchemaAsync | undefined> | StrictObjectSchemaAsync | undefined> ? Omit & { /** * The object entries. */ readonly entries: RequiredEntries; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps>, InferObjectOutput>>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise>, NonOptionalIssue | InferIssue>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput>; readonly output: InferObjectOutput>; readonly issue: NonOptionalIssue | InferIssue; } | undefined; } : TSchema extends LooseObjectSchemaAsync | undefined> ? Omit & { /** * The object entries. */ readonly entries: RequiredEntries; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: unknown; }, InferObjectOutput> & { [key: string]: unknown; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise> & { [key: string]: unknown; }, NonOptionalIssue | InferIssue>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: unknown; }; readonly output: InferObjectOutput> & { [key: string]: unknown; }; readonly issue: NonOptionalIssue | InferIssue; } | undefined; } : TSchema extends ObjectWithRestSchemaAsync | undefined> ? Omit & { /** * The object entries. */ readonly entries: RequiredEntries; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps> & { [key: string]: InferInput; }, InferObjectOutput> & { [key: string]: InferOutput; }>; /** * Parses unknown input. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise> & { [key: string]: InferOutput; }, NonOptionalIssue | InferIssue>>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: InferObjectInput> & { [key: string]: InferInput; }; readonly output: InferObjectOutput> & { [key: string]: InferOutput; }; readonly issue: NonOptionalIssue | InferIssue; } | undefined; } : never; /** * Creates a modified copy of an object schema that marks all entries as required. * * @param schema The schema to modify. * * @returns An object schema. */ declare function requiredAsync(schema: TSchema): SchemaWithRequiredAsync; /** * Creates a modified copy of an object schema that marks all entries as required. * * @param schema The schema to modify. * @param message The error message. * * @returns An object schema. */ declare function requiredAsync | undefined>(schema: TSchema, message: TMessage): SchemaWithRequiredAsync; /** * Creates a modified copy of an object schema that marks the selected entries * as required. * * @param schema The schema to modify. * @param keys The selected entries. * * @returns An object schema. */ declare function requiredAsync>(schema: TSchema, keys: TKeys): SchemaWithRequiredAsync; /** * Creates a modified copy of an object schema that marks the selected entries * as required. * * @param schema The schema to modify. * @param keys The selected entries. * @param message The error message. * * @returns An object schema. */ declare function requiredAsync, const TMessage extends ErrorMessage | undefined>(schema: TSchema, keys: TKeys, message: TMessage): SchemaWithRequiredAsync; //#endregion //#region src/methods/safeParse/types.d.ts /** * Safe parse result type. */ type SafeParseResult> | BaseSchemaAsync>> = { /** * Whether is's typed. */ readonly typed: true; /** * Whether it's successful. */ readonly success: true; /** * The output value. */ readonly output: InferOutput; /** * The issues, if any. */ readonly issues: undefined; } | { readonly typed: true; readonly success: false; readonly output: InferOutput; readonly issues: [InferIssue, ...InferIssue[]]; } | { readonly typed: false; readonly success: false; readonly output: unknown; readonly issues: [InferIssue, ...InferIssue[]]; }; //#endregion //#region src/methods/safeParse/safeParse.d.ts /** * Parses an unknown input based on a schema. * * @param schema The schema to be used. * @param input The input to be parsed. * @param config The parse configuration. * * @returns The parse result. */ declare function safeParse>>(schema: TSchema, input: unknown, config?: Config>): SafeParseResult; //#endregion //#region src/methods/safeParse/safeParseAsync.d.ts /** * Parses an unknown input based on a schema. * * @param schema The schema to be used. * @param input The input to be parsed. * @param config The parse configuration. * * @returns The parse result. */ declare function safeParseAsync> | BaseSchemaAsync>>(schema: TSchema, input: unknown, config?: Config>): Promise>; //#endregion //#region src/methods/safeParser/safeParser.d.ts /** * The safe parser interface. */ interface SafeParser>, TConfig extends Config> | undefined> { /** * Parses an unknown input based on the schema. */ (input: unknown): SafeParseResult; /** * The schema to be used. */ readonly schema: TSchema; /** * The parser configuration. */ readonly config: TConfig; } /** * Returns a function that parses an unknown input based on a schema. * * @param schema The schema to be used. * * @returns The parser function. */ declare function safeParser>>(schema: TSchema): SafeParser; /** * Returns a function that parses an unknown input based on a schema. * * @param schema The schema to be used. * @param config The parser configuration. * * @returns The parser function. */ declare function safeParser>, const TConfig extends Config> | undefined>(schema: TSchema, config: TConfig): SafeParser; //#endregion //#region src/methods/safeParser/safeParserAsync.d.ts /** * The safe parser async interface. */ interface SafeParserAsync> | BaseSchemaAsync>, TConfig extends Config> | undefined> { /** * Parses an unknown input based on the schema. */ (input: unknown): Promise>; /** * The schema to be used. */ readonly schema: TSchema; /** * The parser configuration. */ readonly config: TConfig; } /** * Returns a function that parses an unknown input based on a schema. * * @param schema The schema to be used. * * @returns The parser function. */ declare function safeParserAsync> | BaseSchemaAsync>>(schema: TSchema): SafeParserAsync; /** * Returns a function that parses an unknown input based on a schema. * * @param schema The schema to be used. * @param config The parser configuration. * * @returns The parser function. */ declare function safeParserAsync> | BaseSchemaAsync>, const TConfig extends Config> | undefined>(schema: TSchema, config: TConfig): SafeParserAsync; //#endregion //#region src/methods/summarize/summarize.d.ts /** * Summarize the error messages of issues in a pretty-printable multi-line string. * * @param issues The list of issues. * * @returns A summary of the issues. * * @beta */ declare function summarize(issues: [BaseIssue, ...BaseIssue[]]): string; //#endregion //#region src/methods/unwrap/unwrap.d.ts /** * Unwraps the wrapped schema. * * @param schema The schema to be unwrapped. * * @returns The unwrapped schema. */ declare function unwrap>, unknown> | ExactOptionalSchemaAsync> | BaseSchemaAsync>, unknown> | NonNullableSchema>, ErrorMessage | undefined> | NonNullableSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined> | NonNullishSchema>, ErrorMessage | undefined> | NonNullishSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined> | NonOptionalSchema>, ErrorMessage | undefined> | NonOptionalSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined> | NullableSchema>, unknown> | NullableSchemaAsync> | BaseSchemaAsync>, unknown> | NullishSchema>, unknown> | NullishSchemaAsync> | BaseSchemaAsync>, unknown> | OptionalSchema>, unknown> | OptionalSchemaAsync> | BaseSchemaAsync>, unknown> | UndefinedableSchema>, unknown> | UndefinedableSchemaAsync> | BaseSchemaAsync>, unknown>>(schema: TSchema): TSchema["wrapped"]; //#endregion //#region src/types/metadata.d.ts /** * Base metadata interface. */ interface BaseMetadata { /** * The object kind. */ readonly kind: "metadata"; /** * The metadata type. */ readonly type: string; /** * The metadata reference. */ readonly reference: (...args: any[]) => BaseMetadata; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: TInput$1; readonly output: TInput$1; readonly issue: never; } | undefined; } /** * Generic metadata type. */ type GenericMetadata = BaseMetadata; //#endregion //#region src/types/dataset.d.ts /** * Unknown dataset interface. */ interface UnknownDataset { /** * Whether is's typed. */ typed?: false; /** * The dataset value. */ value: unknown; /** * The dataset issues. */ issues?: undefined; } /** * Success dataset interface. */ interface SuccessDataset { /** * Whether is's typed. */ typed: true; /** * The dataset value. */ value: TValue$1; /** * The dataset issues. */ issues?: undefined; } /** * Partial dataset interface. */ interface PartialDataset> { /** * Whether is's typed. */ typed: true; /** * The dataset value. */ value: TValue$1; /** * The dataset issues. */ issues: [TIssue, ...TIssue[]]; } /** * Failure dataset interface. */ interface FailureDataset> { /** * Whether is's typed. */ typed: false; /** * The dataset value. */ value: unknown; /** * The dataset issues. */ issues: [TIssue, ...TIssue[]]; } /** * Output dataset type. */ type OutputDataset> = SuccessDataset | PartialDataset | FailureDataset; //#endregion //#region src/types/standard.d.ts /** * The Standard Schema properties interface. */ interface StandardProps { /** * The version number of the standard. */ readonly version: 1; /** * The vendor name of the schema library. */ readonly vendor: "valibot"; /** * Validates unknown input values. */ readonly validate: (value: unknown) => StandardResult | Promise>; /** * Inferred types associated with the schema. */ readonly types?: StandardTypes | undefined; } /** * The result interface of the validate function. */ type StandardResult = StandardSuccessResult | StandardFailureResult; /** * The result interface if validation succeeds. */ interface StandardSuccessResult { /** * The typed output value. */ readonly value: TOutput$1; /** * The non-existent issues. */ readonly issues?: undefined; } /** * The result interface if validation fails. */ interface StandardFailureResult { /** * The issues of failed validation. */ readonly issues: readonly StandardIssue[]; } /** * The issue interface of the failure output. */ interface StandardIssue { /** * The error message of the issue. */ readonly message: string; /** * The path of the issue, if any. */ readonly path?: readonly (PropertyKey | StandardPathItem)[] | undefined; } /** * The path item interface of the issue. */ interface StandardPathItem { /** * The key of the path item. */ readonly key: PropertyKey; } /** * The Standard Schema types interface. */ interface StandardTypes { /** * The input type of the schema. */ readonly input: TInput$1; /** * The output type of the schema. */ readonly output: TOutput$1; } //#endregion //#region src/types/schema.d.ts /** * Base schema interface. */ interface BaseSchema> { /** * The object kind. */ readonly kind: "schema"; /** * The schema type. */ readonly type: string; /** * The schema reference. */ readonly reference: (...args: any[]) => BaseSchema>; /** * The expected property. */ readonly expects: string; /** * Whether it's async. */ readonly async: false; /** * The Standard Schema properties. * * @internal */ readonly "~standard": StandardProps; /** * Parses unknown input values. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => OutputDataset; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: TInput$1; readonly output: TOutput$1; readonly issue: TIssue; } | undefined; } /** * Base schema async interface. */ interface BaseSchemaAsync> extends Omit, "reference" | "async" | "~run"> { /** * The schema reference. */ readonly reference: (...args: any[]) => BaseSchema> | BaseSchemaAsync>; /** * Whether it's async. */ readonly async: true; /** * Parses unknown input values. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: UnknownDataset, config: Config>) => Promise>; } /** * Generic schema type. */ type GenericSchema = BaseIssue> = BaseSchema; /** * Generic schema async type. */ type GenericSchemaAsync = BaseIssue> = BaseSchemaAsync; //#endregion //#region src/types/transformation.d.ts /** * Base transformation interface. */ interface BaseTransformation> { /** * The object kind. */ readonly kind: "transformation"; /** * The transformation type. */ readonly type: string; /** * The transformation reference. */ readonly reference: (...args: any[]) => BaseTransformation>; /** * Whether it's async. */ readonly async: false; /** * Transforms known input values. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: SuccessDataset, config: Config>) => OutputDataset | TIssue>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: TInput$1; readonly output: TOutput$1; readonly issue: TIssue; } | undefined; } /** * Base transformation async interface. */ interface BaseTransformationAsync> extends Omit, "reference" | "async" | "~run"> { /** * The transformation reference. */ readonly reference: (...args: any[]) => BaseTransformation> | BaseTransformationAsync>; /** * Whether it's async. */ readonly async: true; /** * Transforms known input values. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: SuccessDataset, config: Config>) => Promise | TIssue>>; } /** * Generic transformation type. */ type GenericTransformation = BaseIssue> = BaseTransformation; /** * Generic transformation async type. */ type GenericTransformationAsync = BaseIssue> = BaseTransformationAsync; //#endregion //#region src/types/validation.d.ts /** * Base validation interface. */ interface BaseValidation> { /** * The object kind. */ readonly kind: "validation"; /** * The validation type. */ readonly type: string; /** * The validation reference. */ readonly reference: (...args: any[]) => BaseValidation>; /** * The expected property. */ readonly expects: string | null; /** * Whether it's async. */ readonly async: false; /** * Validates known input values. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: OutputDataset>, config: Config>) => OutputDataset | TIssue>; /** * The input, output and issue type. * * @internal */ readonly "~types"?: { readonly input: TInput$1; readonly output: TOutput$1; readonly issue: TIssue; } | undefined; } /** * Base validation async interface. */ interface BaseValidationAsync> extends Omit, "reference" | "async" | "~run"> { /** * The validation reference. */ readonly reference: (...args: any[]) => BaseValidation> | BaseValidationAsync>; /** * Whether it's async. */ readonly async: true; /** * Validates known input values. * * @param dataset The input dataset. * @param config The configuration. * * @returns The output dataset. * * @internal */ readonly "~run": (dataset: OutputDataset>, config: Config>) => Promise | TIssue>>; } /** * Generic validation type. */ type GenericValidation = BaseIssue> = BaseValidation; /** * Generic validation async type. */ type GenericValidationAsync = BaseIssue> = BaseValidationAsync; //#endregion //#region src/types/infer.d.ts /** * Infer input type. */ type InferInput> | BaseSchemaAsync> | BaseValidation> | BaseValidationAsync> | BaseTransformation> | BaseTransformationAsync> | BaseMetadata> = NonNullable["input"]; /** * Infer output type. */ type InferOutput> | BaseSchemaAsync> | BaseValidation> | BaseValidationAsync> | BaseTransformation> | BaseTransformationAsync> | BaseMetadata> = NonNullable["output"]; /** * Infer issue type. */ type InferIssue> | BaseSchemaAsync> | BaseValidation> | BaseValidationAsync> | BaseTransformation> | BaseTransformationAsync> | BaseMetadata> = NonNullable["issue"]; //#endregion //#region src/types/utils.d.ts /** * Checks if a type is `any`. */ type IsAny = 0 extends 1 & Type ? true : false; /** * Checks if a type is `never`. */ type IsNever = [Type] extends [never] ? true : false; /** * Extracts `null` from a type. */ type NonNullable$1 = TValue$1 extends null ? never : TValue$1; /** * Extracts `null` and `undefined` from a type. */ type NonNullish = TValue$1 extends null | undefined ? never : TValue$1; /** * Extracts `undefined` from a type. */ type NonOptional = TValue$1 extends undefined ? never : TValue$1; /** * Constructs a type that is maybe readonly. */ type MaybeReadonly = TValue$1 | Readonly; /** * Constructs a type that is maybe a promise. */ type MaybePromise = TValue$1 | Promise; /** * Prettifies a type for better readability. * * Hint: This type has no effect and is only used so that TypeScript displays * the final type in the preview instead of the utility types used. */ type Prettify = { [TKey in keyof TObject]: TObject[TKey] } & {}; /** * Marks specific keys as optional. */ type MarkOptional = { [TKey in keyof TObject]?: unknown } & Omit & Partial>; /** * Merges two objects. Overlapping entries from the second object overwrite * properties from the first object. */ type Merge = Omit & TSecondObject; /** * Extracts first tuple item. */ type FirstTupleItem = TTuple[0]; /** * Extracts last tuple item. */ type LastTupleItem = TTuple[TTuple extends readonly [unknown, ...infer TRest] ? TRest["length"] : never]; /** * Converts union to intersection type. */ type UnionToIntersect = (TUnion extends any ? (arg: TUnion) => void : never) extends ((arg: infer Intersect) => void) ? Intersect : never; /** * Converts union to tuple type using an accumulator. * * For more information: {@link https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-5.html#tail-recursion-elimination-on-conditional-types} */ type UnionToTupleHelper = UnionToIntersect TUnion> extends (() => infer TLast) ? UnionToTupleHelper, [TLast, ...TResult]> : TResult; /** * Converts union to tuple type. */ type UnionToTuple = UnionToTupleHelper; //#endregion //#region src/types/other.d.ts /** * Error message type. */ type ErrorMessage> = ((issue: TIssue) => string) | string; /** * Default type. */ type Default>, TInput$1 extends null | undefined> = MaybeReadonly | TInput$1> | ((dataset?: UnknownDataset, config?: Config>) => MaybeReadonly | TInput$1>) | undefined; /** * Default async type. */ type DefaultAsync> | BaseSchemaAsync>, TInput$1 extends null | undefined> = MaybeReadonly | TInput$1> | ((dataset?: UnknownDataset, config?: Config>) => MaybePromise | TInput$1>>) | undefined; /** * Default value type. */ type DefaultValue>, null | undefined> | DefaultAsync> | BaseSchemaAsync>, null | undefined>> = TDefault extends DefaultAsync> | BaseSchemaAsync>, infer TInput> ? TDefault extends ((dataset?: UnknownDataset, config?: Config>) => MaybePromise | TInput>) ? Awaited> : TDefault : never; //#endregion //#region src/types/object.d.ts /** * Optional entry schema type. */ type OptionalEntrySchema = ExactOptionalSchema>, unknown> | NullishSchema>, unknown> | OptionalSchema>, unknown>; /** * Optional entry schema async type. */ type OptionalEntrySchemaAsync = ExactOptionalSchemaAsync> | BaseSchemaAsync>, unknown> | NullishSchemaAsync> | BaseSchemaAsync>, unknown> | OptionalSchemaAsync> | BaseSchemaAsync>, unknown>; /** * Object entries interface. */ interface ObjectEntries { [key: string]: BaseSchema> | SchemaWithFallback>, unknown> | OptionalEntrySchema; } /** * Object entries async interface. */ interface ObjectEntriesAsync { [key: string]: BaseSchema> | BaseSchemaAsync> | SchemaWithFallback>, unknown> | SchemaWithFallbackAsync> | BaseSchemaAsync>, unknown> | OptionalEntrySchema | OptionalEntrySchemaAsync; } /** * Object keys type. */ type ObjectKeys | undefined> | LooseObjectSchemaAsync | undefined> | ObjectSchema | undefined> | ObjectSchemaAsync | undefined> | ObjectWithRestSchema>, ErrorMessage | undefined> | ObjectWithRestSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined> | StrictObjectSchema | undefined> | StrictObjectSchemaAsync | undefined>> = MaybeReadonly<[keyof TSchema["entries"], ...(keyof TSchema["entries"])[]]>; /** * Infer entries input type. */ type InferEntriesInput = { -readonly [TKey in keyof TEntries$1]: InferInput }; /** * Infer entries output type. */ type InferEntriesOutput = { -readonly [TKey in keyof TEntries$1]: InferOutput }; /** * Optional input keys type. */ type OptionalInputKeys = { [TKey in keyof TEntries$1]: TEntries$1[TKey] extends OptionalEntrySchema | OptionalEntrySchemaAsync ? TKey : never }[keyof TEntries$1]; /** * Optional output keys type. */ type OptionalOutputKeys = { [TKey in keyof TEntries$1]: TEntries$1[TKey] extends OptionalEntrySchema | OptionalEntrySchemaAsync ? undefined extends TEntries$1[TKey]["default"] ? TKey : never : never }[keyof TEntries$1]; /** * Input with question marks type. */ type InputWithQuestionMarks> = MarkOptional>; /** * Output with question marks type. */ type OutputWithQuestionMarks> = MarkOptional>; /** * Readonly output keys type. */ type ReadonlyOutputKeys = { [TKey in keyof TEntries$1]: TEntries$1[TKey] extends SchemaWithPipe | SchemaWithPipeAsync ? ReadonlyAction extends TPipe[number] ? TKey : never : never }[keyof TEntries$1]; /** * Output with readonly type. */ type OutputWithReadonly>> = Readonly & Pick>>; /** * Infer object input type. */ type InferObjectInput = Prettify>>; /** * Infer object output type. */ type InferObjectOutput = Prettify>>>; /** * Infer object issue type. */ type InferObjectIssue = InferIssue; //#endregion //#region src/types/tuple.d.ts /** * Tuple items type. */ type TupleItems = MaybeReadonly>[]>; /** * Tuple items async type. */ type TupleItemsAsync = MaybeReadonly<(BaseSchema> | BaseSchemaAsync>)[]>; /** * Infer tuple input type. */ type InferTupleInput = { -readonly [TKey in keyof TItems$1]: InferInput }; /** * Infer tuple output type. */ type InferTupleOutput = { -readonly [TKey in keyof TItems$1]: InferOutput }; /** * Infer tuple issue type. */ type InferTupleIssue = InferIssue; //#endregion //#region src/types/issue.d.ts /** * Array path item interface. */ interface ArrayPathItem { /** * The path item type. */ readonly type: "array"; /** * The path item origin. */ readonly origin: "value"; /** * The path item input. */ readonly input: MaybeReadonly; /** * The path item key. */ readonly key: number; /** * The path item value. */ readonly value: unknown; } /** * Map path item interface. */ interface MapPathItem { /** * The path item type. */ readonly type: "map"; /** * The path item origin. */ readonly origin: "key" | "value"; /** * The path item input. */ readonly input: Map; /** * The path item key. */ readonly key: unknown; /** * The path item value. */ readonly value: unknown; } /** * Object path item interface. */ interface ObjectPathItem { /** * The path item type. */ readonly type: "object"; /** * The path item origin. */ readonly origin: "key" | "value"; /** * The path item input. */ readonly input: Record; /** * The path item key. */ readonly key: string; /** * The path item value. */ readonly value: unknown; } /** * Set path item interface. */ interface SetPathItem { /** * The path item type. */ readonly type: "set"; /** * The path item origin. */ readonly origin: "value"; /** * The path item input. */ readonly input: Set; /** * The path item key. */ readonly key: null; /** * The path item key. */ readonly value: unknown; } /** * Unknown path item interface. */ interface UnknownPathItem { /** * The path item type. */ readonly type: "unknown"; /** * The path item origin. */ readonly origin: "key" | "value"; /** * The path item input. */ readonly input: unknown; /** * The path item key. */ readonly key: unknown; /** * The path item value. */ readonly value: unknown; } /** * Issue path item type. */ type IssuePathItem = ArrayPathItem | MapPathItem | ObjectPathItem | SetPathItem | UnknownPathItem; /** * Base issue interface. */ interface BaseIssue extends Config> { /** * The issue kind. */ readonly kind: "schema" | "validation" | "transformation"; /** * The issue type. */ readonly type: string; /** * The raw input data. */ readonly input: TInput$1; /** * The expected property. */ readonly expected: string | null; /** * The received property. */ readonly received: string; /** * The error message. */ readonly message: string; /** * The input requirement. */ readonly requirement?: unknown | undefined; /** * The issue path. */ readonly path?: [IssuePathItem, ...IssuePathItem[]] | undefined; /** * The sub issues. */ readonly issues?: [BaseIssue, ...BaseIssue[]] | undefined; } /** * Generic issue type. */ type GenericIssue = BaseIssue; /** * Dot path type. */ type DotPath> | BaseSchemaAsync>> = TKey$1 extends string | number ? `${TKey$1}` | `${TKey$1}.${IssueDotPath}` : never; /** * Object path type. */ type ObjectPath = { [TKey in keyof TEntries$1]: DotPath }[keyof TEntries$1]; /** * Tuple keys type. */ type TupleKeys = Exclude; /** * Tuple path type. */ type TuplePath = { [TKey in TupleKeys]: TItems$1[TKey] extends BaseSchema> | BaseSchemaAsync> ? DotPath : never }[TupleKeys]; /** * Issue dot path type. */ type IssueDotPath> | BaseSchemaAsync>> = TSchema extends SchemaWithPipe ? IssueDotPath> : TSchema extends SchemaWithPipeAsync ? IssueDotPath> : TSchema extends ArraySchema | undefined> ? DotPath : TSchema extends ArraySchemaAsync | undefined> ? DotPath : TSchema extends IntersectSchema | undefined> | UnionSchema>> | undefined> | VariantSchema | undefined> ? IssueDotPath : TSchema extends IntersectSchemaAsync | undefined> | UnionSchemaAsync>> | undefined> | VariantSchemaAsync | undefined> ? IssueDotPath : TSchema extends MapSchema | undefined> | RecordSchema | undefined> ? DotPath, TValue> : TSchema extends MapSchemaAsync | undefined> | RecordSchemaAsync | undefined> ? DotPath, TValue> : TSchema extends LooseObjectSchema | undefined> | ObjectSchema | undefined> | StrictObjectSchema | undefined> ? ObjectPath : TSchema extends LooseObjectSchemaAsync | undefined> | ObjectSchemaAsync | undefined> | StrictObjectSchemaAsync | undefined> ? ObjectPath : TSchema extends ObjectWithRestSchema>, ErrorMessage | undefined> ? string : TSchema extends ObjectWithRestSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined> ? string : TSchema extends SetSchema | undefined> ? DotPath : TSchema extends SetSchemaAsync | undefined> ? DotPath : TSchema extends LooseTupleSchema | undefined> | StrictTupleSchema | undefined> | TupleSchema | undefined> ? TuplePath : TSchema extends LooseTupleSchemaAsync | undefined> | StrictTupleSchemaAsync | undefined> | TupleSchemaAsync | undefined> ? TuplePath : TSchema extends TupleWithRestSchema | undefined> ? TuplePath | DotPath : TSchema extends TupleWithRestSchemaAsync | undefined> ? TuplePath | DotPath : TSchema extends ExactOptionalSchema>, never>> | LazySchema | NonNullableSchema | undefined> | NonNullishSchema | undefined> | NonOptionalSchema | undefined> | NullableSchema>, null>> | NullishSchema>, null | undefined>> | OptionalSchema>, undefined>> | UndefinedableSchema>, undefined>> ? IssueDotPath : TSchema extends ExactOptionalSchemaAsync> | BaseSchemaAsync>, never>> | LazySchemaAsync | NonNullableSchemaAsync | undefined> | NonNullishSchemaAsync | undefined> | NonOptionalSchemaAsync | undefined> | NullableSchemaAsync> | BaseSchemaAsync>, null>> | NullishSchemaAsync> | BaseSchemaAsync>, null | undefined>> | OptionalSchemaAsync> | BaseSchemaAsync>, undefined>> | UndefinedableSchemaAsync> | BaseSchemaAsync>, undefined>> ? IssueDotPath : never; //#endregion //#region src/types/config.d.ts /** * Config interface. */ interface Config> { /** * The selected language. */ readonly lang?: string | undefined; /** * The error message. */ readonly message?: ErrorMessage | undefined; /** * Whether it should be aborted early. */ readonly abortEarly?: boolean | undefined; /** * Whether a pipe should be aborted early. */ readonly abortPipeEarly?: boolean | undefined; } //#endregion //#region src/types/pipe.d.ts /** * Pipe action type. */ type PipeAction> = BaseValidation | BaseTransformation | BaseMetadata; /** * Pipe action async type. */ type PipeActionAsync> = BaseValidationAsync | BaseTransformationAsync; /** * Pipe item type. */ type PipeItem> = BaseSchema | PipeAction; /** * Pipe item async type. */ type PipeItemAsync> = BaseSchemaAsync | PipeActionAsync; /** * Schema without pipe type. */ type SchemaWithoutPipe> | BaseSchemaAsync>> = TSchema & { pipe?: never; }; /** * Generic pipe action type. */ type GenericPipeAction = BaseIssue> = PipeAction; /** * Generic pipe action async type. */ type GenericPipeActionAsync = BaseIssue> = PipeActionAsync; /** * Generic pipe item type. */ type GenericPipeItem = BaseIssue> = PipeItem; /** * Generic pipe item async type. */ type GenericPipeItemAsync = BaseIssue> = PipeItemAsync; //#endregion //#region src/schemas/any/any.d.ts /** * Any schema interface. */ interface AnySchema extends BaseSchema { /** * The schema type. */ readonly type: "any"; /** * The schema reference. */ readonly reference: typeof any; /** * The expected property. */ readonly expects: "any"; } /** * Creates an any schema. * * Hint: This schema function exists only for completeness and is not * recommended in practice. Instead, `unknown` should be used to accept * unknown data. * * @returns An any schema. */ declare function any(): AnySchema; //#endregion //#region src/schemas/array/types.d.ts /** * Array issue interface. */ interface ArrayIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "array"; /** * The expected property. */ readonly expected: "Array"; } //#endregion //#region src/schemas/array/array.d.ts /** * Array schema interface. */ interface ArraySchema>, TMessage extends ErrorMessage | undefined> extends BaseSchema[], InferOutput[], ArrayIssue | InferIssue> { /** * The schema type. */ readonly type: "array"; /** * The schema reference. */ readonly reference: typeof array; /** * The expected property. */ readonly expects: "Array"; /** * The array item schema. */ readonly item: TItem$1; /** * The error message. */ readonly message: TMessage; } /** * Creates an array schema. * * @param item The item schema. * * @returns An array schema. */ declare function array>>(item: TItem$1): ArraySchema; /** * Creates an array schema. * * @param item The item schema. * @param message The error message. * * @returns An array schema. */ declare function array>, const TMessage extends ErrorMessage | undefined>(item: TItem$1, message: TMessage): ArraySchema; //#endregion //#region src/schemas/array/arrayAsync.d.ts /** * Array schema interface. */ interface ArraySchemaAsync> | BaseSchemaAsync>, TMessage extends ErrorMessage | undefined> extends BaseSchemaAsync[], InferOutput[], ArrayIssue | InferIssue> { /** * The schema type. */ readonly type: "array"; /** * The schema reference. */ readonly reference: typeof array | typeof arrayAsync; /** * The expected property. */ readonly expects: "Array"; /** * The array item schema. */ readonly item: TItem$1; /** * The error message. */ readonly message: TMessage; } /** * Creates an array schema. * * @param item The item schema. * * @returns An array schema. */ declare function arrayAsync> | BaseSchemaAsync>>(item: TItem$1): ArraySchemaAsync; /** * Creates an array schema. * * @param item The item schema. * @param message The error message. * * @returns An array schema. */ declare function arrayAsync> | BaseSchemaAsync>, const TMessage extends ErrorMessage | undefined>(item: TItem$1, message: TMessage): ArraySchemaAsync; //#endregion //#region src/schemas/bigint/bigint.d.ts /** * Bigint issue interface. */ interface BigintIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "bigint"; /** * The expected property. */ readonly expected: "bigint"; } /** * Bigint schema interface. */ interface BigintSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "bigint"; /** * The schema reference. */ readonly reference: typeof bigint; /** * The expected property. */ readonly expects: "bigint"; /** * The error message. */ readonly message: TMessage; } /** * Creates a bigint schema. * * @returns A bigint schema. */ declare function bigint(): BigintSchema; /** * Creates a bigint schema. * * @param message The error message. * * @returns A bigint schema. */ declare function bigint | undefined>(message: TMessage): BigintSchema; //#endregion //#region src/schemas/blob/blob.d.ts /** * Blob issue interface. */ interface BlobIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "blob"; /** * The expected property. */ readonly expected: "Blob"; } /** * Blob schema interface. */ interface BlobSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "blob"; /** * The schema reference. */ readonly reference: typeof blob; /** * The expected property. */ readonly expects: "Blob"; /** * The error message. */ readonly message: TMessage; } /** * Creates a blob schema. * * @returns A blob schema. */ declare function blob(): BlobSchema; /** * Creates a blob schema. * * @param message The error message. * * @returns A blob schema. */ declare function blob | undefined>(message: TMessage): BlobSchema; //#endregion //#region src/schemas/boolean/boolean.d.ts /** * Boolean issue interface. */ interface BooleanIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "boolean"; /** * The expected property. */ readonly expected: "boolean"; } /** * Boolean schema interface. */ interface BooleanSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "boolean"; /** * The schema reference. */ readonly reference: typeof boolean; /** * The expected property. */ readonly expects: "boolean"; /** * The error message. */ readonly message: TMessage; } /** * Creates a boolean schema. * * @returns A boolean schema. */ declare function boolean(): BooleanSchema; /** * Creates a boolean schema. * * @param message The error message. * * @returns A boolean schema. */ declare function boolean | undefined>(message: TMessage): BooleanSchema; //#endregion //#region src/schemas/custom/types.d.ts /** * Custom issue interface. */ interface CustomIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "custom"; /** * The expected property. */ readonly expected: "unknown"; } //#endregion //#region src/schemas/custom/custom.d.ts /** * Check type. */ type Check = (input: unknown) => boolean; /** * Custom schema interface. */ interface CustomSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "custom"; /** * The schema reference. */ readonly reference: typeof custom; /** * The expected property. */ readonly expects: "unknown"; /** * The type check function. */ readonly check: Check; /** * The error message. */ readonly message: TMessage; } /** * Creates a custom schema. * * @param check The type check function. * * @returns A custom schema. */ declare function custom(check: Check): CustomSchema; /** * Creates a custom schema. * * @param check The type check function. * @param message The error message. * * @returns A custom schema. */ declare function custom | undefined = ErrorMessage | undefined>(check: Check, message: TMessage): CustomSchema; //#endregion //#region src/schemas/custom/customAsync.d.ts /** * Check async type. */ type CheckAsync = (input: unknown) => MaybePromise; /** * Custom schema async interface. */ interface CustomSchemaAsync | undefined> extends BaseSchemaAsync { /** * The schema type. */ readonly type: "custom"; /** * The schema reference. */ readonly reference: typeof custom | typeof customAsync; /** * The expected property. */ readonly expects: "unknown"; /** * The type check function. */ readonly check: CheckAsync; /** * The error message. */ readonly message: TMessage; } /** * Creates a custom schema. * * @param check The type check function. * * @returns A custom schema. */ declare function customAsync(check: CheckAsync): CustomSchemaAsync; /** * Creates a custom schema. * * @param check The type check function. * @param message The error message. * * @returns A custom schema. */ declare function customAsync | undefined = ErrorMessage | undefined>(check: CheckAsync, message: TMessage): CustomSchemaAsync; //#endregion //#region src/schemas/date/date.d.ts /** * Date issue interface. */ interface DateIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "date"; /** * The expected property. */ readonly expected: "Date"; } /** * Date schema interface. */ interface DateSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "date"; /** * The schema reference. */ readonly reference: typeof date; /** * The expected property. */ readonly expects: "Date"; /** * The error message. */ readonly message: TMessage; } /** * Creates a date schema. * * @returns A date schema. */ declare function date(): DateSchema; /** * Creates a date schema. * * @param message The error message. * * @returns A date schema. */ declare function date | undefined>(message: TMessage): DateSchema; //#endregion //#region src/schemas/enum/enum.d.ts /** * Enum interface. */ interface Enum { [key: string]: string | number; } /** * Enum values type. */ type EnumValues = { [TKey in keyof TEnum]: TKey extends number ? TEnum[TKey] extends string ? TEnum[TEnum[TKey]] extends TKey ? never : TEnum[TKey] : TEnum[TKey] : TKey extends "NaN" | "Infinity" | "-Infinity" ? TEnum[TKey] extends string ? TEnum[TEnum[TKey]] extends number ? never : TEnum[TKey] : TEnum[TKey] : TKey extends `+${number}` ? TEnum[TKey] : TKey extends `${infer TNumber extends number}` ? TEnum[TKey] extends string ? TEnum[TEnum[TKey]] extends TNumber ? never : TEnum[TKey] : TEnum[TKey] : TEnum[TKey] }[keyof TEnum]; /** * Enum issue interface. */ interface EnumIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "enum"; /** * The expected property. */ readonly expected: string; } /** * Enum schema interface. */ interface EnumSchema | undefined> extends BaseSchema, EnumValues, EnumIssue> { /** * The schema type. */ readonly type: "enum"; /** * The schema reference. */ readonly reference: typeof enum_; /** * The enum object. */ readonly enum: TEnum; /** * The enum options. */ readonly options: EnumValues[]; /** * The error message. */ readonly message: TMessage; } /** * Creates an enum schema. * * @param enum__ The enum object. * * @returns An enum schema. */ declare function enum_(enum__: TEnum): EnumSchema; /** * Creates an enum schema. * * @param enum__ The enum object. * @param message The error message. * * @returns An enum schema. */ declare function enum_ | undefined>(enum__: TEnum, message: TMessage): EnumSchema; //#endregion //#region src/schemas/exactOptional/exactOptional.d.ts /** * Exact optional schema interface. */ interface ExactOptionalSchema>, TDefault extends Default> extends BaseSchema, InferOutput, InferIssue> { /** * The schema type. */ readonly type: "exact_optional"; /** * The schema reference. */ readonly reference: typeof exactOptional; /** * The expected property. */ readonly expects: TWrapped$1["expects"]; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The default value. */ readonly default: TDefault; } /** * Creates an exact optional schema. * * @param wrapped The wrapped schema. * * @returns An exact optional schema. */ declare function exactOptional>>(wrapped: TWrapped$1): ExactOptionalSchema; /** * Creates an exact optional schema. * * @param wrapped The wrapped schema. * @param default_ The default value. * * @returns An exact optional schema. */ declare function exactOptional>, const TDefault extends Default>(wrapped: TWrapped$1, default_: TDefault): ExactOptionalSchema; //#endregion //#region src/schemas/exactOptional/exactOptionalAsync.d.ts /** * Exact optional schema async interface. */ interface ExactOptionalSchemaAsync> | BaseSchemaAsync>, TDefault extends DefaultAsync> extends BaseSchemaAsync, InferOutput, InferIssue> { /** * The schema type. */ readonly type: "exact_optional"; /** * The schema reference. */ readonly reference: typeof exactOptional | typeof exactOptionalAsync; /** * The expected property. */ readonly expects: TWrapped$1["expects"]; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The default value. */ readonly default: TDefault; } /** * Creates an exact optional schema. * * @param wrapped The wrapped schema. * * @returns An exact optional schema. */ declare function exactOptionalAsync> | BaseSchemaAsync>>(wrapped: TWrapped$1): ExactOptionalSchemaAsync; /** * Creates an exact optional schema. * * @param wrapped The wrapped schema. * @param default_ The default value. * * @returns An exact optional schema. */ declare function exactOptionalAsync> | BaseSchemaAsync>, const TDefault extends DefaultAsync>(wrapped: TWrapped$1, default_: TDefault): ExactOptionalSchemaAsync; //#endregion //#region src/schemas/file/file.d.ts /** * File issue interface. */ interface FileIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "file"; /** * The expected property. */ readonly expected: "File"; } /** * File schema interface. */ interface FileSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "file"; /** * The schema reference. */ readonly reference: typeof file; /** * The expected property. */ readonly expects: "File"; /** * The error message. */ readonly message: TMessage; } /** * Creates a file schema. * * @returns A file schema. */ declare function file(): FileSchema; /** * Creates a file schema. * * @param message The error message. * * @returns A file schema. */ declare function file | undefined>(message: TMessage): FileSchema; //#endregion //#region src/schemas/function/function.d.ts /** * Function issue interface. */ interface FunctionIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "function"; /** * The expected property. */ readonly expected: "Function"; } /** * Function schema interface. */ interface FunctionSchema | undefined> extends BaseSchema<(...args: unknown[]) => unknown, (...args: unknown[]) => unknown, FunctionIssue> { /** * The schema type. */ readonly type: "function"; /** * The schema reference. */ readonly reference: typeof function_; /** * The expected property. */ readonly expects: "Function"; /** * The error message. */ readonly message: TMessage; } /** * Creates a function schema. * * @returns A function schema. */ declare function function_(): FunctionSchema; /** * Creates a function schema. * * @param message The error message. * * @returns A function schema. */ declare function function_ | undefined>(message: TMessage): FunctionSchema; //#endregion //#region src/schemas/instance/instance.d.ts /** * Class type. */ type Class = new (...args: any[]) => any; /** * Instance issue interface. */ interface InstanceIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "instance"; /** * The expected property. */ readonly expected: string; } /** * Instance schema interface. */ interface InstanceSchema | undefined> extends BaseSchema, InstanceType, InstanceIssue> { /** * The schema type. */ readonly type: "instance"; /** * The schema reference. */ readonly reference: typeof instance; /** * The class of the instance. */ readonly class: TClass; /** * The error message. */ readonly message: TMessage; } /** * Creates an instance schema. * * @param class_ The class of the instance. * * @returns An instance schema. */ declare function instance(class_: TClass): InstanceSchema; /** * Creates an instance schema. * * @param class_ The class of the instance. * @param message The error message. * * @returns An instance schema. */ declare function instance | undefined>(class_: TClass, message: TMessage): InstanceSchema; //#endregion //#region src/schemas/intersect/types.d.ts /** * Intersect issue interface. */ interface IntersectIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "intersect"; /** * The expected property. */ readonly expected: string; } /** * Intersect options type. */ type IntersectOptions = MaybeReadonly>[]>; /** * Intersect options async type. */ type IntersectOptionsAsync = MaybeReadonly<(BaseSchema> | BaseSchemaAsync>)[]>; /** * Infer option type. */ type InferOption = BaseSchema> | BaseSchemaAsync>; /** * Infer intersect input type. */ type InferIntersectInput = TOptions$1 extends readonly [InferOption, ...infer TRest] ? TRest extends readonly [InferOption, ...InferOption[]] ? TInput & InferIntersectInput : TInput : never; /** * Infer intersect output type. */ type InferIntersectOutput = TOptions$1 extends readonly [InferOption, ...infer TRest] ? TRest extends readonly [InferOption, ...InferOption[]] ? TOutput & InferIntersectOutput : TOutput : never; //#endregion //#region src/schemas/intersect/intersect.d.ts /** * Intersect schema interface. */ interface IntersectSchema | undefined> extends BaseSchema, InferIntersectOutput, IntersectIssue | InferIssue> { /** * The schema type. */ readonly type: "intersect"; /** * The schema reference. */ readonly reference: typeof intersect; /** * The intersect options. */ readonly options: TOptions$1; /** * The error message. */ readonly message: TMessage; } /** * Creates an intersect schema. * * @param options The intersect options. * * @returns An intersect schema. */ declare function intersect(options: TOptions$1): IntersectSchema; /** * Creates an intersect schema. * * @param options The intersect options. * @param message The error message. * * @returns An intersect schema. */ declare function intersect | undefined>(options: TOptions$1, message: TMessage): IntersectSchema; //#endregion //#region src/schemas/intersect/intersectAsync.d.ts /** * Intersect schema async interface. */ interface IntersectSchemaAsync | undefined> extends BaseSchemaAsync, InferIntersectOutput, IntersectIssue | InferIssue> { /** * The schema type. */ readonly type: "intersect"; /** * The schema reference. */ readonly reference: typeof intersect | typeof intersectAsync; /** * The intersect options. */ readonly options: TOptions$1; /** * The error message. */ readonly message: TMessage; } /** * Creates an intersect schema. * * @param options The intersect options. * * @returns An intersect schema. */ declare function intersectAsync(options: TOptions$1): IntersectSchemaAsync; /** * Creates an intersect schema. * * @param options The intersect options. * @param message The error message. * * @returns An intersect schema. */ declare function intersectAsync | undefined>(options: TOptions$1, message: TMessage): IntersectSchemaAsync; //#endregion //#region src/schemas/lazy/lazy.d.ts /** * Lazy schema interface. */ interface LazySchema>> extends BaseSchema, InferOutput, InferIssue> { /** * The schema type. */ readonly type: "lazy"; /** * The schema reference. */ readonly reference: typeof lazy; /** * The expected property. */ readonly expects: "unknown"; /** * The schema getter. */ readonly getter: (input: unknown) => TWrapped$1; } /** * Creates a lazy schema. * * @param getter The schema getter. * * @returns A lazy schema. */ declare function lazy>>(getter: (input: unknown) => TWrapped$1): LazySchema; //#endregion //#region src/schemas/lazy/lazyAsync.d.ts /** * Lazy schema async interface. */ interface LazySchemaAsync> | BaseSchemaAsync>> extends BaseSchemaAsync, InferOutput, InferIssue> { /** * The schema type. */ readonly type: "lazy"; /** * The schema reference. */ readonly reference: typeof lazy | typeof lazyAsync; /** * The expected property. */ readonly expects: "unknown"; /** * The schema getter. */ readonly getter: (input: unknown) => MaybePromise; } /** * Creates a lazy schema. * * @param getter The schema getter. * * @returns A lazy schema. */ declare function lazyAsync> | BaseSchemaAsync>>(getter: (input: unknown) => MaybePromise): LazySchemaAsync; //#endregion //#region src/schemas/literal/literal.d.ts /** * Literal type. */ type Literal = bigint | boolean | number | string | symbol; /** * Literal issue interface. */ interface LiteralIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "literal"; /** * The expected property. */ readonly expected: string; } /** * Literal schema interface. */ interface LiteralSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "literal"; /** * The schema reference. */ readonly reference: typeof literal; /** * The literal value. */ readonly literal: TLiteral; /** * The error message. */ readonly message: TMessage; } /** * Creates a literal schema. * * @param literal_ The literal value. * * @returns A literal schema. */ declare function literal(literal_: TLiteral): LiteralSchema; /** * Creates a literal schema. * * @param literal_ The literal value. * @param message The error message. * * @returns A literal schema. */ declare function literal | undefined>(literal_: TLiteral, message: TMessage): LiteralSchema; //#endregion //#region src/schemas/looseObject/types.d.ts /** * Loose object issue interface. */ interface LooseObjectIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "loose_object"; /** * The expected property. */ readonly expected: "Object" | `"${string}"`; } //#endregion //#region src/schemas/looseObject/looseObject.d.ts /** * Loose object schema interface. */ interface LooseObjectSchema | undefined> extends BaseSchema & { [key: string]: unknown; }, InferObjectOutput & { [key: string]: unknown; }, LooseObjectIssue | InferObjectIssue> { /** * The schema type. */ readonly type: "loose_object"; /** * The schema reference. */ readonly reference: typeof looseObject; /** * The expected property. */ readonly expects: "Object"; /** * The entries schema. */ readonly entries: TEntries$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a loose object schema. * * @param entries The entries schema. * * @returns A loose object schema. */ declare function looseObject(entries: TEntries$1): LooseObjectSchema; /** * Creates a loose object schema. * * @param entries The entries schema. * @param message The error message. * * @returns A loose object schema. */ declare function looseObject | undefined>(entries: TEntries$1, message: TMessage): LooseObjectSchema; //#endregion //#region src/schemas/looseObject/looseObjectAsync.d.ts /** * Object schema async interface. */ interface LooseObjectSchemaAsync | undefined> extends BaseSchemaAsync & { [key: string]: unknown; }, InferObjectOutput & { [key: string]: unknown; }, LooseObjectIssue | InferObjectIssue> { /** * The schema type. */ readonly type: "loose_object"; /** * The schema reference. */ readonly reference: typeof looseObject | typeof looseObjectAsync; /** * The expected property. */ readonly expects: "Object"; /** * The entries schema. */ readonly entries: TEntries$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a loose object schema. * * @param entries The entries schema. * * @returns A loose object schema. */ declare function looseObjectAsync(entries: TEntries$1): LooseObjectSchemaAsync; /** * Creates a loose object schema. * * @param entries The entries schema. * @param message The error message. * * @returns A loose object schema. */ declare function looseObjectAsync | undefined>(entries: TEntries$1, message: TMessage): LooseObjectSchemaAsync; //#endregion //#region src/schemas/looseTuple/types.d.ts /** * Loose tuple issue interface. */ interface LooseTupleIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "loose_tuple"; /** * The expected property. */ readonly expected: "Array"; } //#endregion //#region src/schemas/looseTuple/looseTuple.d.ts /** * Loose tuple schema interface. */ interface LooseTupleSchema | undefined> extends BaseSchema<[...InferTupleInput, ...unknown[]], [...InferTupleOutput, ...unknown[]], LooseTupleIssue | InferTupleIssue> { /** * The schema type. */ readonly type: "loose_tuple"; /** * The schema reference. */ readonly reference: typeof looseTuple; /** * The expected property. */ readonly expects: "Array"; /** * The items schema. */ readonly items: TItems$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a loose tuple schema. * * @param items The items schema. * * @returns A loose tuple schema. */ declare function looseTuple(items: TItems$1): LooseTupleSchema; /** * Creates a loose tuple schema. * * @param items The items schema. * @param message The error message. * * @returns A loose tuple schema. */ declare function looseTuple | undefined>(items: TItems$1, message: TMessage): LooseTupleSchema; //#endregion //#region src/schemas/looseTuple/looseTupleAsync.d.ts /** * Loose tuple schema async interface. */ interface LooseTupleSchemaAsync | undefined> extends BaseSchemaAsync<[...InferTupleInput, ...unknown[]], [...InferTupleOutput, ...unknown[]], LooseTupleIssue | InferTupleIssue> { /** * The schema type. */ readonly type: "loose_tuple"; /** * The schema reference. */ readonly reference: typeof looseTuple | typeof looseTupleAsync; /** * The expected property. */ readonly expects: "Array"; /** * The items schema. */ readonly items: TItems$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a loose tuple schema. * * @param items The items schema. * * @returns A loose tuple schema. */ declare function looseTupleAsync(items: TItems$1): LooseTupleSchemaAsync; /** * Creates a loose tuple schema. * * @param items The items schema. * @param message The error message. * * @returns A loose tuple schema. */ declare function looseTupleAsync | undefined>(items: TItems$1, message: TMessage): LooseTupleSchemaAsync; //#endregion //#region src/schemas/map/types.d.ts /** * Map issue interface. */ interface MapIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "map"; /** * The expected property. */ readonly expected: "Map"; } /** * Infer map input type. */ type InferMapInput> | BaseSchemaAsync>, TValue$1 extends BaseSchema> | BaseSchemaAsync>> = Map, InferInput>; /** * Infer map output type. */ type InferMapOutput> | BaseSchemaAsync>, TValue$1 extends BaseSchema> | BaseSchemaAsync>> = Map, InferOutput>; //#endregion //#region src/schemas/map/map.d.ts /** * Map schema interface. */ interface MapSchema>, TValue$1 extends BaseSchema>, TMessage extends ErrorMessage | undefined> extends BaseSchema, InferMapOutput, MapIssue | InferIssue | InferIssue> { /** * The schema type. */ readonly type: "map"; /** * The schema reference. */ readonly reference: typeof map; /** * The expected property. */ readonly expects: "Map"; /** * The map key schema. */ readonly key: TKey$1; /** * The map value schema. */ readonly value: TValue$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a map schema. * * @param key The key schema. * @param value The value schema. * * @returns A map schema. */ declare function map>, const TValue$1 extends BaseSchema>>(key: TKey$1, value: TValue$1): MapSchema; /** * Creates a map schema. * * @param key The key schema. * @param value The value schema. * @param message The error message. * * @returns A map schema. */ declare function map>, const TValue$1 extends BaseSchema>, const TMessage extends ErrorMessage | undefined>(key: TKey$1, value: TValue$1, message: TMessage): MapSchema; //#endregion //#region src/schemas/map/mapAsync.d.ts /** * Map schema async interface. */ interface MapSchemaAsync> | BaseSchemaAsync>, TValue$1 extends BaseSchema> | BaseSchemaAsync>, TMessage extends ErrorMessage | undefined> extends BaseSchemaAsync, InferMapOutput, MapIssue | InferIssue | InferIssue> { /** * The schema type. */ readonly type: "map"; /** * The schema reference. */ readonly reference: typeof map | typeof mapAsync; /** * The expected property. */ readonly expects: "Map"; /** * The map key schema. */ readonly key: TKey$1; /** * The map value schema. */ readonly value: TValue$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a map schema. * * @param key The key schema. * @param value The value schema. * * @returns A map schema. */ declare function mapAsync> | BaseSchemaAsync>, const TValue$1 extends BaseSchema> | BaseSchemaAsync>>(key: TKey$1, value: TValue$1): MapSchemaAsync; /** * Creates a map schema. * * @param key The key schema. * @param value The value schema. * @param message The error message. * * @returns A map schema. */ declare function mapAsync> | BaseSchemaAsync>, const TValue$1 extends BaseSchema> | BaseSchemaAsync>, const TMessage extends ErrorMessage | undefined>(key: TKey$1, value: TValue$1, message: TMessage): MapSchemaAsync; //#endregion //#region src/schemas/nan/nan.d.ts /** * NaN issue interface. */ interface NanIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "nan"; /** * The expected property. */ readonly expected: "NaN"; } /** * NaN schema interface. */ interface NanSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "nan"; /** * The schema reference. */ readonly reference: typeof nan; /** * The expected property. */ readonly expects: "NaN"; /** * The error message. */ readonly message: TMessage; } /** * Creates a NaN schema. * * @returns A NaN schema. */ declare function nan(): NanSchema; /** * Creates a NaN schema. * * @param message The error message. * * @returns A NaN schema. */ declare function nan | undefined>(message: TMessage): NanSchema; //#endregion //#region src/schemas/never/never.d.ts /** * Never issue interface. */ interface NeverIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "never"; /** * The expected property. */ readonly expected: "never"; } /** * Never schema interface. */ interface NeverSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "never"; /** * The schema reference. */ readonly reference: typeof never; /** * The expected property. */ readonly expects: "never"; /** * The error message. */ readonly message: TMessage; } /** * Creates a never schema. * * @returns A never schema. */ declare function never(): NeverSchema; /** * Creates a never schema. * * @param message The error message. * * @returns A never schema. */ declare function never | undefined>(message: TMessage): NeverSchema; //#endregion //#region src/schemas/union/types.d.ts /** * Union issue interface. */ interface UnionIssue> extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "union"; /** * The expected property. */ readonly expected: string; /** * The sub issues. */ readonly issues?: [TSubIssue, ...TSubIssue[]]; } //#endregion //#region src/schemas/union/union.d.ts /** * Union options type. */ type UnionOptions = MaybeReadonly>[]>; /** * Union schema interface. */ interface UnionSchema>> | undefined> extends BaseSchema, InferOutput, UnionIssue> | InferIssue> { /** * The schema type. */ readonly type: "union"; /** * The schema reference. */ readonly reference: typeof union; /** * The union options. */ readonly options: TOptions$1; /** * The error message. */ readonly message: TMessage; } /** * Creates an union schema. * * @param options The union options. * * @returns An union schema. */ declare function union(options: TOptions$1): UnionSchema; /** * Creates an union schema. * * @param options The union options. * @param message The error message. * * @returns An union schema. */ declare function union>> | undefined>(options: TOptions$1, message: TMessage): UnionSchema; //#endregion //#region src/schemas/union/unionAsync.d.ts /** * Union options async type. */ type UnionOptionsAsync = MaybeReadonly<(BaseSchema> | BaseSchemaAsync>)[]>; /** * Union schema async interface. */ interface UnionSchemaAsync>> | undefined> extends BaseSchemaAsync, InferOutput, UnionIssue> | InferIssue> { /** * The schema type. */ readonly type: "union"; /** * The schema reference. */ readonly reference: typeof union | typeof unionAsync; /** * The union options. */ readonly options: TOptions$1; /** * The error message. */ readonly message: TMessage; } /** * Creates an union schema. * * @param options The union options. * * @returns An union schema. */ declare function unionAsync(options: TOptions$1): UnionSchemaAsync; /** * Creates an union schema. * * @param options The union options. * @param message The error message. * * @returns An union schema. */ declare function unionAsync>> | undefined>(options: TOptions$1, message: TMessage): UnionSchemaAsync; //#endregion //#region src/schemas/nonNullable/types.d.ts /** * Non nullable issue interface. */ interface NonNullableIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "non_nullable"; /** * The expected property. */ readonly expected: "!null"; } /** * Infer non nullable input type. */ type InferNonNullableInput> | BaseSchemaAsync>> = NonNullable$1>; /** * Infer non nullable output type. */ type InferNonNullableOutput> | BaseSchemaAsync>> = NonNullable$1>; /** * Infer non nullable issue type. */ type InferNonNullableIssue> | BaseSchemaAsync>> = TWrapped$1 extends UnionSchema>> | undefined> | UnionSchemaAsync>> | undefined> ? Exclude, { type: "null" | "union"; }> | UnionIssue> : Exclude, { type: "null"; }>; //#endregion //#region src/schemas/nonNullable/nonNullable.d.ts /** * Non nullable schema interface. */ interface NonNullableSchema>, TMessage extends ErrorMessage | undefined> extends BaseSchema, InferNonNullableOutput, NonNullableIssue | InferNonNullableIssue> { /** * The schema type. */ readonly type: "non_nullable"; /** * The schema reference. */ readonly reference: typeof nonNullable; /** * The expected property. */ readonly expects: "!null"; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a non nullable schema. * * @param wrapped The wrapped schema. * * @returns A non nullable schema. */ declare function nonNullable>>(wrapped: TWrapped$1): NonNullableSchema; /** * Creates a non nullable schema. * * @param wrapped The wrapped schema. * @param message The error message. * * @returns A non nullable schema. */ declare function nonNullable>, const TMessage extends ErrorMessage | undefined>(wrapped: TWrapped$1, message: TMessage): NonNullableSchema; //#endregion //#region src/schemas/nonNullable/nonNullableAsync.d.ts /** * Non nullable schema async interface. */ interface NonNullableSchemaAsync> | BaseSchemaAsync>, TMessage extends ErrorMessage | undefined> extends BaseSchemaAsync, InferNonNullableOutput, NonNullableIssue | InferNonNullableIssue> { /** * The schema type. */ readonly type: "non_nullable"; /** * The schema reference. */ readonly reference: typeof nonNullable | typeof nonNullableAsync; /** * The expected property. */ readonly expects: "!null"; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a non nullable schema. * * @param wrapped The wrapped schema. * * @returns A non nullable schema. */ declare function nonNullableAsync> | BaseSchemaAsync>>(wrapped: TWrapped$1): NonNullableSchemaAsync; /** * Creates a non nullable schema. * * @param wrapped The wrapped schema. * @param message The error message. * * @returns A non nullable schema. */ declare function nonNullableAsync> | BaseSchemaAsync>, const TMessage extends ErrorMessage | undefined>(wrapped: TWrapped$1, message: TMessage): NonNullableSchemaAsync; //#endregion //#region src/schemas/nonNullish/types.d.ts /** * Non nullish issue interface. */ interface NonNullishIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "non_nullish"; /** * The expected property. */ readonly expected: "(!null & !undefined)"; } /** * Infer non nullish input type. */ type InferNonNullishInput> | BaseSchemaAsync>> = NonNullish>; /** * Infer non nullish output type. */ type InferNonNullishOutput> | BaseSchemaAsync>> = NonNullish>; /** * Infer non nullish issue type. */ type InferNonNullishIssue> | BaseSchemaAsync>> = TWrapped$1 extends UnionSchema>> | undefined> | UnionSchemaAsync>> | undefined> ? Exclude, { type: "null" | "undefined" | "union"; }> | UnionIssue> : Exclude, { type: "null" | "undefined"; }>; //#endregion //#region src/schemas/nonNullish/nonNullish.d.ts /** * Non nullish schema interface. */ interface NonNullishSchema>, TMessage extends ErrorMessage | undefined> extends BaseSchema, InferNonNullishOutput, NonNullishIssue | InferNonNullishIssue> { /** * The schema type. */ readonly type: "non_nullish"; /** * The schema reference. */ readonly reference: typeof nonNullish; /** * The expected property. */ readonly expects: "(!null & !undefined)"; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a non nullish schema. * * @param wrapped The wrapped schema. * * @returns A non nullish schema. */ declare function nonNullish>>(wrapped: TWrapped$1): NonNullishSchema; /** * Creates a non nullish schema. * * @param wrapped The wrapped schema. * @param message The error message. * * @returns A non nullish schema. */ declare function nonNullish>, const TMessage extends ErrorMessage | undefined>(wrapped: TWrapped$1, message: TMessage): NonNullishSchema; //#endregion //#region src/schemas/nonNullish/nonNullishAsync.d.ts /** * Non nullish schema async interface. */ interface NonNullishSchemaAsync> | BaseSchemaAsync>, TMessage extends ErrorMessage | undefined> extends BaseSchemaAsync, InferNonNullishOutput, NonNullishIssue | InferNonNullishIssue> { /** * The schema type. */ readonly type: "non_nullish"; /** * The schema reference. */ readonly reference: typeof nonNullish | typeof nonNullishAsync; /** * The expected property. */ readonly expects: "(!null & !undefined)"; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a non nullish schema. * * @param wrapped The wrapped schema. * * @returns A non nullish schema. */ declare function nonNullishAsync> | BaseSchemaAsync>>(wrapped: TWrapped$1): NonNullishSchemaAsync; /** * Creates a non nullish schema. * * @param wrapped The wrapped schema. * @param message The error message. * * @returns A non nullish schema. */ declare function nonNullishAsync> | BaseSchemaAsync>, const TMessage extends ErrorMessage | undefined>(wrapped: TWrapped$1, message: TMessage): NonNullishSchemaAsync; //#endregion //#region src/schemas/nonOptional/types.d.ts /** * Non optional issue interface. */ interface NonOptionalIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "non_optional"; /** * The expected property. */ readonly expected: "!undefined"; } /** * Infer non optional input type. */ type InferNonOptionalInput> | BaseSchemaAsync>> = NonOptional>; /** * Infer non optional output type. */ type InferNonOptionalOutput> | BaseSchemaAsync>> = NonOptional>; /** * Infer non optional issue type. */ type InferNonOptionalIssue> | BaseSchemaAsync>> = TWrapped$1 extends UnionSchema>> | undefined> | UnionSchemaAsync>> | undefined> ? Exclude, { type: "undefined" | "union"; }> | UnionIssue> : Exclude, { type: "undefined"; }>; //#endregion //#region src/schemas/nonOptional/nonOptional.d.ts /** * Non optional schema interface. */ interface NonOptionalSchema>, TMessage extends ErrorMessage | undefined> extends BaseSchema, InferNonOptionalOutput, NonOptionalIssue | InferNonOptionalIssue> { /** * The schema type. */ readonly type: "non_optional"; /** * The schema reference. */ readonly reference: typeof nonOptional; /** * The expected property. */ readonly expects: "!undefined"; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a non optional schema. * * @param wrapped The wrapped schema. * * @returns A non optional schema. */ declare function nonOptional>>(wrapped: TWrapped$1): NonOptionalSchema; /** * Creates a non optional schema. * * @param wrapped The wrapped schema. * @param message The error message. * * @returns A non optional schema. */ declare function nonOptional>, const TMessage extends ErrorMessage | undefined>(wrapped: TWrapped$1, message: TMessage): NonOptionalSchema; //#endregion //#region src/schemas/nonOptional/nonOptionalAsync.d.ts /** * Non optional schema async interface. */ interface NonOptionalSchemaAsync> | BaseSchemaAsync>, TMessage extends ErrorMessage | undefined> extends BaseSchemaAsync, InferNonOptionalOutput, NonOptionalIssue | InferNonOptionalIssue> { /** * The schema type. */ readonly type: "non_optional"; /** * The schema reference. */ readonly reference: typeof nonOptional | typeof nonOptionalAsync; /** * The expected property. */ readonly expects: "!undefined"; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a non optional schema. * * @param wrapped The wrapped schema. * * @returns A non optional schema. */ declare function nonOptionalAsync> | BaseSchemaAsync>>(wrapped: TWrapped$1): NonOptionalSchemaAsync; /** * Creates a non optional schema. * * @param wrapped The wrapped schema. * @param message The error message. * * @returns A non optional schema. */ declare function nonOptionalAsync> | BaseSchemaAsync>, const TMessage extends ErrorMessage | undefined>(wrapped: TWrapped$1, message: TMessage): NonOptionalSchemaAsync; //#endregion //#region src/schemas/null/null.d.ts /** * Null issue interface. */ interface NullIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "null"; /** * The expected property. */ readonly expected: "null"; } /** * Null schema interface. */ interface NullSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "null"; /** * The schema reference. */ readonly reference: typeof null_; /** * The expected property. */ readonly expects: "null"; /** * The error message. */ readonly message: TMessage; } /** * Creates a null schema. * * @returns A null schema. */ declare function null_(): NullSchema; /** * Creates a null schema. * * @param message The error message. * * @returns A null schema. */ declare function null_ | undefined>(message: TMessage): NullSchema; //#endregion //#region src/schemas/nullable/types.d.ts /** * Infer nullable output type. */ type InferNullableOutput> | BaseSchemaAsync>, TDefault extends DefaultAsync> = undefined extends TDefault ? InferOutput | null : InferOutput | Extract, null>; //#endregion //#region src/schemas/nullable/nullable.d.ts /** * Nullable schema interface. */ interface NullableSchema>, TDefault extends Default> extends BaseSchema | null, InferNullableOutput, InferIssue> { /** * The schema type. */ readonly type: "nullable"; /** * The schema reference. */ readonly reference: typeof nullable; /** * The expected property. */ readonly expects: `(${TWrapped$1["expects"]} | null)`; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The default value. */ readonly default: TDefault; } /** * Creates a nullable schema. * * @param wrapped The wrapped schema. * * @returns A nullable schema. */ declare function nullable>>(wrapped: TWrapped$1): NullableSchema; /** * Creates a nullable schema. * * @param wrapped The wrapped schema. * @param default_ The default value. * * @returns A nullable schema. */ declare function nullable>, const TDefault extends Default>(wrapped: TWrapped$1, default_: TDefault): NullableSchema; //#endregion //#region src/schemas/nullable/nullableAsync.d.ts /** * Nullable schema async interface. */ interface NullableSchemaAsync> | BaseSchemaAsync>, TDefault extends DefaultAsync> extends BaseSchemaAsync | null, InferNullableOutput, InferIssue> { /** * The schema type. */ readonly type: "nullable"; /** * The schema reference. */ readonly reference: typeof nullable | typeof nullableAsync; /** * The expected property. */ readonly expects: `(${TWrapped$1["expects"]} | null)`; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The default value. */ readonly default: TDefault; } /** * Creates a nullable schema. * * @param wrapped The wrapped schema. * * @returns A nullable schema. */ declare function nullableAsync> | BaseSchemaAsync>>(wrapped: TWrapped$1): NullableSchemaAsync; /** * Creates a nullable schema. * * @param wrapped The wrapped schema. * @param default_ The default value. * * @returns A nullable schema. */ declare function nullableAsync> | BaseSchemaAsync>, const TDefault extends DefaultAsync>(wrapped: TWrapped$1, default_: TDefault): NullableSchemaAsync; //#endregion //#region src/schemas/nullish/types.d.ts /** * Infer nullish output type. */ type InferNullishOutput> | BaseSchemaAsync>, TDefault extends DefaultAsync> = undefined extends TDefault ? InferOutput | null | undefined : InferOutput | Extract, null | undefined>; //#endregion //#region src/schemas/nullish/nullish.d.ts /** * Nullish schema interface. */ interface NullishSchema>, TDefault extends Default> extends BaseSchema | null | undefined, InferNullishOutput, InferIssue> { /** * The schema type. */ readonly type: "nullish"; /** * The schema reference. */ readonly reference: typeof nullish; /** * The expected property. */ readonly expects: `(${TWrapped$1["expects"]} | null | undefined)`; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The default value. */ readonly default: TDefault; } /** * Creates a nullish schema. * * @param wrapped The wrapped schema. * * @returns A nullish schema. */ declare function nullish>>(wrapped: TWrapped$1): NullishSchema; /** * Creates a nullish schema. * * @param wrapped The wrapped schema. * @param default_ The default value. * * @returns A nullish schema. */ declare function nullish>, const TDefault extends Default>(wrapped: TWrapped$1, default_: TDefault): NullishSchema; //#endregion //#region src/schemas/nullish/nullishAsync.d.ts /** * Nullish schema async interface. */ interface NullishSchemaAsync> | BaseSchemaAsync>, TDefault extends DefaultAsync> extends BaseSchemaAsync | null | undefined, InferNullishOutput, InferIssue> { /** * The schema type. */ readonly type: "nullish"; /** * The schema reference. */ readonly reference: typeof nullish | typeof nullishAsync; /** * The expected property. */ readonly expects: `(${TWrapped$1["expects"]} | null | undefined)`; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The default value. */ readonly default: TDefault; } /** * Creates a nullish schema. * * @param wrapped The wrapped schema. * * @returns A nullish schema. */ declare function nullishAsync> | BaseSchemaAsync>>(wrapped: TWrapped$1): NullishSchemaAsync; /** * Creates a nullish schema. * * @param wrapped The wrapped schema. * @param default_ The default value. * * @returns A nullish schema. */ declare function nullishAsync> | BaseSchemaAsync>, const TDefault extends DefaultAsync>(wrapped: TWrapped$1, default_: TDefault): NullishSchemaAsync; //#endregion //#region src/schemas/number/number.d.ts /** * Number issue interface. */ interface NumberIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "number"; /** * The expected property. */ readonly expected: "number"; } /** * Number schema interface. */ interface NumberSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "number"; /** * The schema reference. */ readonly reference: typeof number; /** * The expected property. */ readonly expects: "number"; /** * The error message. */ readonly message: TMessage; } /** * Creates a number schema. * * @returns A number schema. */ declare function number(): NumberSchema; /** * Creates a number schema. * * @param message The error message. * * @returns A number schema. */ declare function number | undefined>(message: TMessage): NumberSchema; //#endregion //#region src/schemas/object/types.d.ts /** * Object issue interface. */ interface ObjectIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "object"; /** * The expected property. */ readonly expected: "Object" | `"${string}"`; } //#endregion //#region src/schemas/object/object.d.ts /** * Object schema interface. */ interface ObjectSchema | undefined> extends BaseSchema, InferObjectOutput, ObjectIssue | InferObjectIssue> { /** * The schema type. */ readonly type: "object"; /** * The schema reference. */ readonly reference: typeof object; /** * The expected property. */ readonly expects: "Object"; /** * The entries schema. */ readonly entries: TEntries$1; /** * The error message. */ readonly message: TMessage; } /** * Creates an object schema. * * Hint: This schema removes unknown entries. The output will only include the * entries you specify. To include unknown entries, use `looseObject`. To * return an issue for unknown entries, use `strictObject`. To include and * validate unknown entries, use `objectWithRest`. * * @param entries The entries schema. * * @returns An object schema. */ declare function object(entries: TEntries$1): ObjectSchema; /** * Creates an object schema. * * Hint: This schema removes unknown entries. The output will only include the * entries you specify. To include unknown entries, use `looseObject`. To * return an issue for unknown entries, use `strictObject`. To include and * validate unknown entries, use `objectWithRest`. * * @param entries The entries schema. * @param message The error message. * * @returns An object schema. */ declare function object | undefined>(entries: TEntries$1, message: TMessage): ObjectSchema; //#endregion //#region src/schemas/object/objectAsync.d.ts /** * Object schema async interface. */ interface ObjectSchemaAsync | undefined> extends BaseSchemaAsync, InferObjectOutput, ObjectIssue | InferObjectIssue> { /** * The schema type. */ readonly type: "object"; /** * The schema reference. */ readonly reference: typeof object | typeof objectAsync; /** * The expected property. */ readonly expects: "Object"; /** * The entries schema. */ readonly entries: TEntries$1; /** * The error message. */ readonly message: TMessage; } /** * Creates an object schema. * * Hint: This schema removes unknown entries. The output will only include the * entries you specify. To include unknown entries, use `looseObjectAsync`. To * return an issue for unknown entries, use `strictObjectAsync`. To include and * validate unknown entries, use `objectWithRestAsync`. * * @param entries The entries schema. * * @returns An object schema. */ declare function objectAsync(entries: TEntries$1): ObjectSchemaAsync; /** * Creates an object schema. * * Hint: This schema removes unknown entries. The output will only include the * entries you specify. To include unknown entries, use `looseObjectAsync`. To * return an issue for unknown entries, use `strictObjectAsync`. To include and * validate unknown entries, use `objectWithRestAsync`. * * @param entries The entries schema. * @param message The error message. * * @returns An object schema. */ declare function objectAsync | undefined>(entries: TEntries$1, message: TMessage): ObjectSchemaAsync; //#endregion //#region src/schemas/objectWithRest/types.d.ts /** * Object with rest issue interface. */ interface ObjectWithRestIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "object_with_rest"; /** * The expected property. */ readonly expected: "Object" | `"${string}"`; } //#endregion //#region src/schemas/objectWithRest/objectWithRest.d.ts /** * Object with rest schema interface. */ interface ObjectWithRestSchema>, TMessage extends ErrorMessage | undefined> extends BaseSchema & { [key: string]: InferInput; }, InferObjectOutput & { [key: string]: InferOutput; }, ObjectWithRestIssue | InferObjectIssue | InferIssue> { /** * The schema type. */ readonly type: "object_with_rest"; /** * The schema reference. */ readonly reference: typeof objectWithRest; /** * The expected property. */ readonly expects: "Object"; /** * The entries schema. */ readonly entries: TEntries$1; /** * The rest schema. */ readonly rest: TRest$1; /** * The error message. */ readonly message: TMessage; } /** * Creates an object with rest schema. * * @param entries The entries schema. * @param rest The rest schema. * * @returns An object with rest schema. */ declare function objectWithRest>>(entries: TEntries$1, rest: TRest$1): ObjectWithRestSchema; /** * Creates an object with rest schema. * * @param entries The entries schema. * @param rest The rest schema. * @param message The error message. * * @returns An object with rest schema. */ declare function objectWithRest>, const TMessage extends ErrorMessage | undefined>(entries: TEntries$1, rest: TRest$1, message: TMessage): ObjectWithRestSchema; //#endregion //#region src/schemas/objectWithRest/objectWithRestAsync.d.ts /** * Object schema async interface. */ interface ObjectWithRestSchemaAsync> | BaseSchemaAsync>, TMessage extends ErrorMessage | undefined> extends BaseSchemaAsync & { [key: string]: InferInput; }, InferObjectOutput & { [key: string]: InferOutput; }, ObjectWithRestIssue | InferObjectIssue | InferIssue> { /** * The schema type. */ readonly type: "object_with_rest"; /** * The schema reference. */ readonly reference: typeof objectWithRest | typeof objectWithRestAsync; /** * The expected property. */ readonly expects: "Object"; /** * The entries schema. */ readonly entries: TEntries$1; /** * The rest schema. */ readonly rest: TRest$1; /** * The error message. */ readonly message: TMessage; } /** * Creates an object with rest schema. * * @param entries The entries schema. * @param rest The rest schema. * * @returns An object with rest schema. */ declare function objectWithRestAsync> | BaseSchemaAsync>>(entries: TEntries$1, rest: TRest$1): ObjectWithRestSchemaAsync; /** * Creates an object with rest schema. * * @param entries The entries schema. * @param rest The rest schema. * @param message The error message. * * @returns An object with rest schema. */ declare function objectWithRestAsync> | BaseSchemaAsync>, const TMessage extends ErrorMessage | undefined>(entries: TEntries$1, rest: TRest$1, message: TMessage): ObjectWithRestSchemaAsync; //#endregion //#region src/schemas/optional/types.d.ts /** * Infer optional output type. */ type InferOptionalOutput> | BaseSchemaAsync>, TDefault extends DefaultAsync> = undefined extends TDefault ? InferOutput | undefined : InferOutput | Extract, undefined>; //#endregion //#region src/schemas/optional/optional.d.ts /** * Optional schema interface. */ interface OptionalSchema>, TDefault extends Default> extends BaseSchema | undefined, InferOptionalOutput, InferIssue> { /** * The schema type. */ readonly type: "optional"; /** * The schema reference. */ readonly reference: typeof optional; /** * The expected property. */ readonly expects: `(${TWrapped$1["expects"]} | undefined)`; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The default value. */ readonly default: TDefault; } /** * Creates an optional schema. * * @param wrapped The wrapped schema. * * @returns An optional schema. */ declare function optional>>(wrapped: TWrapped$1): OptionalSchema; /** * Creates an optional schema. * * @param wrapped The wrapped schema. * @param default_ The default value. * * @returns An optional schema. */ declare function optional>, const TDefault extends Default>(wrapped: TWrapped$1, default_: TDefault): OptionalSchema; //#endregion //#region src/schemas/optional/optionalAsync.d.ts /** * Optional schema async interface. */ interface OptionalSchemaAsync> | BaseSchemaAsync>, TDefault extends DefaultAsync> extends BaseSchemaAsync | undefined, InferOptionalOutput, InferIssue> { /** * The schema type. */ readonly type: "optional"; /** * The schema reference. */ readonly reference: typeof optional | typeof optionalAsync; /** * The expected property. */ readonly expects: `(${TWrapped$1["expects"]} | undefined)`; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The default value. */ readonly default: TDefault; } /** * Creates an optional schema. * * @param wrapped The wrapped schema. * * @returns An optional schema. */ declare function optionalAsync> | BaseSchemaAsync>>(wrapped: TWrapped$1): OptionalSchemaAsync; /** * Creates an optional schema. * * @param wrapped The wrapped schema. * @param default_ The default value. * * @returns An optional schema. */ declare function optionalAsync> | BaseSchemaAsync>, const TDefault extends DefaultAsync>(wrapped: TWrapped$1, default_: TDefault): OptionalSchemaAsync; //#endregion //#region src/schemas/picklist/picklist.d.ts /** * Picklist options type. */ type PicklistOptions = MaybeReadonly<(string | number | bigint)[]>; /** * Picklist issue interface. */ interface PicklistIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "picklist"; /** * The expected property. */ readonly expected: string; } /** * Picklist schema interface. */ interface PicklistSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "picklist"; /** * The schema reference. */ readonly reference: typeof picklist; /** * The picklist options. */ readonly options: TOptions$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a picklist schema. * * @param options The picklist options. * * @returns A picklist schema. */ declare function picklist(options: TOptions$1): PicklistSchema; /** * Creates a picklist schema. * * @param options The picklist options. * @param message The error message. * * @returns A picklist schema. */ declare function picklist | undefined>(options: TOptions$1, message: TMessage): PicklistSchema; //#endregion //#region src/schemas/promise/promise.d.ts /** * Promise issue interface. */ interface PromiseIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "promise"; /** * The expected property. */ readonly expected: "Promise"; } /** * Promise schema interface. */ interface PromiseSchema | undefined> extends BaseSchema, Promise, PromiseIssue> { /** * The schema type. */ readonly type: "promise"; /** * The schema reference. */ readonly reference: typeof promise; /** * The expected property. */ readonly expects: "Promise"; /** * The error message. */ readonly message: TMessage; } /** * Creates a promise schema. * * @returns A promise schema. */ declare function promise(): PromiseSchema; /** * Creates a promise schema. * * @param message The error message. * * @returns A promise schema. */ declare function promise | undefined>(message: TMessage): PromiseSchema; //#endregion //#region src/schemas/record/types.d.ts /** * Record issue interface. */ interface RecordIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "record"; /** * The expected property. */ readonly expected: "Object"; } /** * Is literal type. */ type IsLiteral = string extends TKey$1 ? false : number extends TKey$1 ? false : symbol extends TKey$1 ? false : TKey$1 extends Brand ? false : true; /** * Optional keys type. */ type OptionalKeys> = { [TKey in keyof TObject]: IsLiteral extends true ? TKey : never }[keyof TObject]; /** * With question marks type. * * Hint: We mark an entry as optional if we detect that its key is a literal * type. The reason for this is that it is not technically possible to detect * missing literal keys without restricting the key schema to `string`, `enum` * and `picklist`. However, if `enum` and `picklist` are used, it is better to * use `object` with `entriesFromList` because it already covers the needed * functionality. This decision also reduces the bundle size of `record`, * because it only needs to check the entries of the input and not any missing * keys. */ type WithQuestionMarks> = MarkOptional>; /** * With readonly type. */ type WithReadonly> | BaseSchemaAsync>, TObject extends WithQuestionMarks>> = TValue$1 extends SchemaWithPipe | SchemaWithPipeAsync ? ReadonlyAction extends TPipe[number] ? Readonly : TObject : TObject; /** * Infer record input type. */ type InferRecordInput> | BaseSchemaAsync>, TValue$1 extends BaseSchema> | BaseSchemaAsync>> = Prettify, InferInput>>>; /** * Infer record output type. */ type InferRecordOutput> | BaseSchemaAsync>, TValue$1 extends BaseSchema> | BaseSchemaAsync>> = Prettify, InferOutput>>>>; //#endregion //#region src/schemas/record/record.d.ts /** * Record schema interface. */ interface RecordSchema>, TValue$1 extends BaseSchema>, TMessage extends ErrorMessage | undefined> extends BaseSchema, InferRecordOutput, RecordIssue | InferIssue | InferIssue> { /** * The schema type. */ readonly type: "record"; /** * The schema reference. */ readonly reference: typeof record; /** * The expected property. */ readonly expects: "Object"; /** * The record key schema. */ readonly key: TKey$1; /** * The record value schema. */ readonly value: TValue$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a record schema. * * @param key The key schema. * @param value The value schema. * * @returns A record schema. */ declare function record>, const TValue$1 extends BaseSchema>>(key: TKey$1, value: TValue$1): RecordSchema; /** * Creates a record schema. * * @param key The key schema. * @param value The value schema. * @param message The error message. * * @returns A record schema. */ declare function record>, const TValue$1 extends BaseSchema>, const TMessage extends ErrorMessage | undefined>(key: TKey$1, value: TValue$1, message: TMessage): RecordSchema; //#endregion //#region src/schemas/record/recordAsync.d.ts /** * Record schema async interface. */ interface RecordSchemaAsync> | BaseSchemaAsync>, TValue$1 extends BaseSchema> | BaseSchemaAsync>, TMessage extends ErrorMessage | undefined> extends BaseSchemaAsync, InferRecordOutput, RecordIssue | InferIssue | InferIssue> { /** * The schema type. */ readonly type: "record"; /** * The schema reference. */ readonly reference: typeof record | typeof recordAsync; /** * The expected property. */ readonly expects: "Object"; /** * The record key schema. */ readonly key: TKey$1; /** * The record value schema. */ readonly value: TValue$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a record schema. * * @param key The key schema. * @param value The value schema. * * @returns A record schema. */ declare function recordAsync> | BaseSchemaAsync>, const TValue$1 extends BaseSchema> | BaseSchemaAsync>>(key: TKey$1, value: TValue$1): RecordSchemaAsync; /** * Creates a record schema. * * @param key The key schema. * @param value The value schema. * @param message The error message. * * @returns A record schema. */ declare function recordAsync> | BaseSchemaAsync>, const TValue$1 extends BaseSchema> | BaseSchemaAsync>, const TMessage extends ErrorMessage | undefined>(key: TKey$1, value: TValue$1, message: TMessage): RecordSchemaAsync; //#endregion //#region src/schemas/set/types.d.ts /** * Set issue interface. */ interface SetIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "set"; /** * The expected property. */ readonly expected: "Set"; } /** * Infer set input type. */ type InferSetInput> | BaseSchemaAsync>> = Set>; /** * Infer set output type. */ type InferSetOutput> | BaseSchemaAsync>> = Set>; //#endregion //#region src/schemas/set/set.d.ts /** * Set schema interface. */ interface SetSchema>, TMessage extends ErrorMessage | undefined> extends BaseSchema, InferSetOutput, SetIssue | InferIssue> { /** * The schema type. */ readonly type: "set"; /** * The schema reference. */ readonly reference: typeof set; /** * The expected property. */ readonly expects: "Set"; /** * The set value schema. */ readonly value: TValue$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a set schema. * * @param value The value schema. * * @returns A set schema. */ declare function set>>(value: TValue$1): SetSchema; /** * Creates a set schema. * * @param value The value schema. * @param message The error message. * * @returns A set schema. */ declare function set>, const TMessage extends ErrorMessage | undefined>(value: TValue$1, message: TMessage): SetSchema; //#endregion //#region src/schemas/set/setAsync.d.ts /** * Set schema async interface. */ interface SetSchemaAsync> | BaseSchemaAsync>, TMessage extends ErrorMessage | undefined> extends BaseSchemaAsync, InferSetOutput, SetIssue | InferIssue> { /** * The schema type. */ readonly type: "set"; /** * The schema reference. */ readonly reference: typeof set | typeof setAsync; /** * The expected property. */ readonly expects: "Set"; /** * The set value schema. */ readonly value: TValue$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a set schema. * * @param value The value schema. * * @returns A set schema. */ declare function setAsync> | BaseSchemaAsync>>(value: TValue$1): SetSchemaAsync; /** * Creates a set schema. * * @param value The value schema. * @param message The error message. * * @returns A set schema. */ declare function setAsync> | BaseSchemaAsync>, const TMessage extends ErrorMessage | undefined>(value: TValue$1, message: TMessage): SetSchemaAsync; //#endregion //#region src/schemas/strictObject/types.d.ts /** * Strict object issue interface. */ interface StrictObjectIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "strict_object"; /** * The expected property. */ readonly expected: "Object" | `"${string}"` | "never"; } //#endregion //#region src/schemas/strictObject/strictObject.d.ts /** * Strict object schema interface. */ interface StrictObjectSchema | undefined> extends BaseSchema, InferObjectOutput, StrictObjectIssue | InferObjectIssue> { /** * The schema type. */ readonly type: "strict_object"; /** * The schema reference. */ readonly reference: typeof strictObject; /** * The expected property. */ readonly expects: "Object"; /** * The entries schema. */ readonly entries: TEntries$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a strict object schema. * * @param entries The entries schema. * * @returns A strict object schema. */ declare function strictObject(entries: TEntries$1): StrictObjectSchema; /** * Creates a strict object schema. * * @param entries The entries schema. * @param message The error message. * * @returns A strict object schema. */ declare function strictObject | undefined>(entries: TEntries$1, message: TMessage): StrictObjectSchema; //#endregion //#region src/schemas/strictObject/strictObjectAsync.d.ts /** * Strict object schema async interface. */ interface StrictObjectSchemaAsync | undefined> extends BaseSchemaAsync, InferObjectOutput, StrictObjectIssue | InferObjectIssue> { /** * The schema type. */ readonly type: "strict_object"; /** * The schema reference. */ readonly reference: typeof strictObject | typeof strictObjectAsync; /** * The expected property. */ readonly expects: "Object"; /** * The entries schema. */ readonly entries: TEntries$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a strict object schema. * * @param entries The entries schema. * * @returns A strict object schema. */ declare function strictObjectAsync(entries: TEntries$1): StrictObjectSchemaAsync; /** * Creates a strict object schema. * * @param entries The entries schema. * @param message The error message. * * @returns A strict object schema. */ declare function strictObjectAsync | undefined>(entries: TEntries$1, message: TMessage): StrictObjectSchemaAsync; //#endregion //#region src/schemas/strictTuple/types.d.ts /** * Strict tuple issue interface. */ interface StrictTupleIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "strict_tuple"; /** * The expected property. */ readonly expected: "Array" | "never"; } //#endregion //#region src/schemas/strictTuple/strictTuple.d.ts /** * Strict tuple schema interface. */ interface StrictTupleSchema | undefined> extends BaseSchema, InferTupleOutput, StrictTupleIssue | InferTupleIssue> { /** * The schema type. */ readonly type: "strict_tuple"; /** * The schema reference. */ readonly reference: typeof strictTuple; /** * The expected property. */ readonly expects: "Array"; /** * The items schema. */ readonly items: TItems$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a strict tuple schema. * * @param items The items schema. * * @returns A strict tuple schema. */ declare function strictTuple(items: TItems$1): StrictTupleSchema; /** * Creates a strict tuple schema. * * @param items The items schema. * @param message The error message. * * @returns A strict tuple schema. */ declare function strictTuple | undefined>(items: TItems$1, message: TMessage): StrictTupleSchema; //#endregion //#region src/schemas/strictTuple/strictTupleAsync.d.ts /** * Strict tuple schema async interface. */ interface StrictTupleSchemaAsync | undefined> extends BaseSchemaAsync, InferTupleOutput, StrictTupleIssue | InferTupleIssue> { /** * The schema type. */ readonly type: "strict_tuple"; /** * The schema reference. */ readonly reference: typeof strictTuple | typeof strictTupleAsync; /** * The expected property. */ readonly expects: "Array"; /** * The items schema. */ readonly items: TItems$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a strict tuple schema. * * @param items The items schema. * * @returns A strict tuple schema. */ declare function strictTupleAsync(items: TItems$1): StrictTupleSchemaAsync; /** * Creates a strict tuple schema. * * @param items The items schema. * @param message The error message. * * @returns A strict tuple schema. */ declare function strictTupleAsync | undefined>(items: TItems$1, message: TMessage): StrictTupleSchemaAsync; //#endregion //#region src/schemas/string/string.d.ts /** * String issue interface. */ interface StringIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "string"; /** * The expected property. */ readonly expected: "string"; } /** * String schema interface. */ interface StringSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "string"; /** * The schema reference. */ readonly reference: typeof string; /** * The expected property. */ readonly expects: "string"; /** * The error message. */ readonly message: TMessage; } /** * Creates a string schema. * * @returns A string schema. */ declare function string(): StringSchema; /** * Creates a string schema. * * @param message The error message. * * @returns A string schema. */ declare function string | undefined>(message: TMessage): StringSchema; //#endregion //#region src/schemas/symbol/symbol.d.ts /** * Symbol issue interface. */ interface SymbolIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "symbol"; /** * The expected property. */ readonly expected: "symbol"; } /** * Symbol schema interface. */ interface SymbolSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "symbol"; /** * The schema reference. */ readonly reference: typeof symbol; /** * The expected property. */ readonly expects: "symbol"; /** * The error message. */ readonly message: TMessage; } /** * Creates a symbol schema. * * @returns A symbol schema. */ declare function symbol(): SymbolSchema; /** * Creates a symbol schema. * * @param message The error message. * * @returns A symbol schema. */ declare function symbol | undefined>(message: TMessage): SymbolSchema; //#endregion //#region src/schemas/tuple/types.d.ts /** * Tuple issue interface. */ interface TupleIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "tuple"; /** * The expected property. */ readonly expected: "Array"; } //#endregion //#region src/schemas/tuple/tuple.d.ts /** * Tuple schema interface. */ interface TupleSchema | undefined> extends BaseSchema, InferTupleOutput, TupleIssue | InferTupleIssue> { /** * The schema type. */ readonly type: "tuple"; /** * The schema reference. */ readonly reference: typeof tuple; /** * The expected property. */ readonly expects: "Array"; /** * The items schema. */ readonly items: TItems$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a tuple schema. * * Hint: This schema removes unknown items. The output will only include the * items you specify. To include unknown items, use `looseTuple`. To * return an issue for unknown items, use `strictTuple`. To include and * validate unknown items, use `tupleWithRest`. * * @param items The items schema. * * @returns A tuple schema. */ declare function tuple(items: TItems$1): TupleSchema; /** * Creates a tuple schema. * * Hint: This schema removes unknown items. The output will only include the * items you specify. To include unknown items, use `looseTuple`. To * return an issue for unknown items, use `strictTuple`. To include and * validate unknown items, use `tupleWithRest`. * * @param items The items schema. * @param message The error message. * * @returns A tuple schema. */ declare function tuple | undefined>(items: TItems$1, message: TMessage): TupleSchema; //#endregion //#region src/schemas/tuple/tupleAsync.d.ts /** * Tuple schema async interface. */ interface TupleSchemaAsync | undefined> extends BaseSchemaAsync, InferTupleOutput, TupleIssue | InferTupleIssue> { /** * The schema type. */ readonly type: "tuple"; /** * The schema reference. */ readonly reference: typeof tuple | typeof tupleAsync; /** * The expected property. */ readonly expects: "Array"; /** * The items schema. */ readonly items: TItems$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a tuple schema. * * Hint: This schema removes unknown items. The output will only include the * items you specify. To include unknown items, use `looseTupleAsync`. To * return an issue for unknown items, use `strictTupleAsync`. To include and * validate unknown items, use `tupleWithRestAsync`. * * @param items The items schema. * * @returns A tuple schema. */ declare function tupleAsync(items: TItems$1): TupleSchemaAsync; /** * Creates a tuple schema. * * Hint: This schema removes unknown items. The output will only include the * items you specify. To include unknown items, use `looseTupleAsync`. To * return an issue for unknown items, use `strictTupleAsync`. To include and * validate unknown items, use `tupleWithRestAsync`. * * @param items The items schema. * @param message The error message. * * @returns A tuple schema. */ declare function tupleAsync | undefined>(items: TItems$1, message: TMessage): TupleSchemaAsync; //#endregion //#region src/schemas/tupleWithRest/types.d.ts /** * Tuple with rest issue interface. */ interface TupleWithRestIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "tuple_with_rest"; /** * The expected property. */ readonly expected: "Array"; } //#endregion //#region src/schemas/tupleWithRest/tupleWithRest.d.ts /** * Tuple with rest schema interface. */ interface TupleWithRestSchema>, TMessage extends ErrorMessage | undefined> extends BaseSchema<[...InferTupleInput, ...InferInput[]], [...InferTupleOutput, ...InferOutput[]], TupleWithRestIssue | InferTupleIssue | InferIssue> { /** * The schema type. */ readonly type: "tuple_with_rest"; /** * The schema reference. */ readonly reference: typeof tupleWithRest; /** * The expected property. */ readonly expects: "Array"; /** * The items schema. */ readonly items: TItems$1; /** * The rest schema. */ readonly rest: TRest$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a tuple with rest schema. * * @param items The items schema. * @param rest The rest schema. * * @returns A tuple with rest schema. */ declare function tupleWithRest>>(items: TItems$1, rest: TRest$1): TupleWithRestSchema; /** * Creates a tuple with rest schema. * * @param items The items schema. * @param rest The rest schema. * @param message The error message. * * @returns A tuple with rest schema. */ declare function tupleWithRest>, const TMessage extends ErrorMessage | undefined>(items: TItems$1, rest: TRest$1, message: TMessage): TupleWithRestSchema; //#endregion //#region src/schemas/tupleWithRest/tupleWithRestAsync.d.ts /** * Tuple with rest schema async interface. */ interface TupleWithRestSchemaAsync> | BaseSchemaAsync>, TMessage extends ErrorMessage | undefined> extends BaseSchemaAsync<[...InferTupleInput, ...InferInput[]], [...InferTupleOutput, ...InferOutput[]], TupleWithRestIssue | InferTupleIssue | InferIssue> { /** * The schema type. */ readonly type: "tuple_with_rest"; /** * The schema reference. */ readonly reference: typeof tupleWithRest | typeof tupleWithRestAsync; /** * The expected property. */ readonly expects: "Array"; /** * The items schema. */ readonly items: TItems$1; /** * The rest schema. */ readonly rest: TRest$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a tuple with rest schema. * * @param items The items schema. * @param rest The rest schema. * * @returns A tuple with rest schema. */ declare function tupleWithRestAsync> | BaseSchemaAsync>>(items: TItems$1, rest: TRest$1): TupleWithRestSchemaAsync; /** * Creates a tuple with rest schema. * * @param items The items schema. * @param rest The rest schema. * @param message The error message. * * @returns A tuple with rest schema. */ declare function tupleWithRestAsync> | BaseSchemaAsync>, const TMessage extends ErrorMessage | undefined>(items: TItems$1, rest: TRest$1, message: TMessage): TupleWithRestSchemaAsync; //#endregion //#region src/schemas/undefined/undefined.d.ts /** * Undefined issue interface. */ interface UndefinedIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "undefined"; /** * The expected property. */ readonly expected: "undefined"; } /** * Undefined schema interface. */ interface UndefinedSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "undefined"; /** * The schema reference. */ readonly reference: typeof undefined_; /** * The expected property. */ readonly expects: "undefined"; /** * The error message. */ readonly message: TMessage; } /** * Creates an undefined schema. * * @returns An undefined schema. */ declare function undefined_(): UndefinedSchema; /** * Creates an undefined schema. * * @param message The error message. * * @returns An undefined schema. */ declare function undefined_ | undefined>(message: TMessage): UndefinedSchema; //#endregion //#region src/schemas/undefinedable/types.d.ts /** * Infer undefinedable output type. */ type InferUndefinedableOutput> | BaseSchemaAsync>, TDefault extends DefaultAsync> = undefined extends TDefault ? InferOutput | undefined : InferOutput | Extract, undefined>; //#endregion //#region src/schemas/undefinedable/undefinedable.d.ts /** * Undefinedable schema interface. */ interface UndefinedableSchema>, TDefault extends Default> extends BaseSchema | undefined, InferUndefinedableOutput, InferIssue> { /** * The schema type. */ readonly type: "undefinedable"; /** * The schema reference. */ readonly reference: typeof undefinedable; /** * The expected property. */ readonly expects: `(${TWrapped$1["expects"]} | undefined)`; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The default value. */ readonly default: TDefault; } /** * Creates an undefinedable schema. * * @param wrapped The wrapped schema. * * @returns An undefinedable schema. */ declare function undefinedable>>(wrapped: TWrapped$1): UndefinedableSchema; /** * Creates an undefinedable schema. * * @param wrapped The wrapped schema. * @param default_ The default value. * * @returns An undefinedable schema. */ declare function undefinedable>, const TDefault extends Default>(wrapped: TWrapped$1, default_: TDefault): UndefinedableSchema; //#endregion //#region src/schemas/undefinedable/undefinedableAsync.d.ts /** * Undefinedable schema async interface. */ interface UndefinedableSchemaAsync> | BaseSchemaAsync>, TDefault extends DefaultAsync> extends BaseSchemaAsync | undefined, InferUndefinedableOutput, InferIssue> { /** * The schema type. */ readonly type: "undefinedable"; /** * The schema reference. */ readonly reference: typeof undefinedable | typeof undefinedableAsync; /** * The expected property. */ readonly expects: `(${TWrapped$1["expects"]} | undefined)`; /** * The wrapped schema. */ readonly wrapped: TWrapped$1; /** * The default value. */ readonly default: TDefault; } /** * Creates an undefinedable schema. * * @param wrapped The wrapped schema. * * @returns An undefinedable schema. */ declare function undefinedableAsync> | BaseSchemaAsync>>(wrapped: TWrapped$1): UndefinedableSchemaAsync; /** * Creates an undefinedable schema. * * @param wrapped The wrapped schema. * @param default_ The default value. * * @returns An undefinedable schema. */ declare function undefinedableAsync> | BaseSchemaAsync>, const TDefault extends DefaultAsync>(wrapped: TWrapped$1, default_: TDefault): UndefinedableSchemaAsync; //#endregion //#region src/schemas/unknown/unknown.d.ts /** * Unknown schema interface. */ interface UnknownSchema extends BaseSchema { /** * The schema type. */ readonly type: "unknown"; /** * The schema reference. */ readonly reference: typeof unknown; /** * The expected property. */ readonly expects: "unknown"; } /** * Creates a unknown schema. * * @returns A unknown schema. */ declare function unknown(): UnknownSchema; //#endregion //#region src/schemas/variant/variant.d.ts /** * Variant schema interface. */ interface VariantSchema, TMessage extends ErrorMessage | undefined> extends BaseSchema, InferOutput, VariantIssue | InferVariantIssue> { /** * The schema type. */ readonly type: "variant"; /** * The schema reference. */ readonly reference: typeof variant; /** * The expected property. */ readonly expects: "Object"; /** * The discriminator key. */ readonly key: TKey$1; /** * The variant options. */ readonly options: TOptions$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a variant schema. * * @param key The discriminator key. * @param options The variant options. * * @returns A variant schema. */ declare function variant>(key: TKey$1, options: TOptions$1): VariantSchema; /** * Creates a variant schema. * * @param key The discriminator key. * @param options The variant options. * @param message The error message. * * @returns An variant schema. */ declare function variant, const TMessage extends ErrorMessage | undefined>(key: TKey$1, options: TOptions$1, message: TMessage): VariantSchema; //#endregion //#region src/schemas/variant/variantAsync.d.ts /** * Variant schema async interface. */ interface VariantSchemaAsync, TMessage extends ErrorMessage | undefined> extends BaseSchemaAsync, InferOutput, VariantIssue | InferVariantIssue> { /** * The schema type. */ readonly type: "variant"; /** * The schema reference. */ readonly reference: typeof variant | typeof variantAsync; /** * The expected property. */ readonly expects: "Object"; /** * The discriminator key. */ readonly key: TKey$1; /** * The variant options. */ readonly options: TOptions$1; /** * The error message. */ readonly message: TMessage; } /** * Creates a variant schema. * * @param key The discriminator key. * @param options The variant options. * * @returns A variant schema. */ declare function variantAsync>(key: TKey$1, options: TOptions$1): VariantSchemaAsync; /** * Creates a variant schema. * * @param key The discriminator key. * @param options The variant options. * @param message The error message. * * @returns An variant schema. */ declare function variantAsync, const TMessage extends ErrorMessage | undefined>(key: TKey$1, options: TOptions$1, message: TMessage): VariantSchemaAsync; //#endregion //#region src/schemas/variant/types.d.ts /** * Variant issue interface. */ interface VariantIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "variant"; /** * The expected property. */ readonly expected: string; } /** * Variant option schema interface. */ interface VariantOptionSchema extends BaseSchema> { readonly type: "variant"; readonly reference: typeof variant; readonly key: string; readonly options: VariantOptions; readonly message: ErrorMessage | undefined; } /** * Variant option schema async interface. */ interface VariantOptionSchemaAsync extends BaseSchemaAsync> { readonly type: "variant"; readonly reference: typeof variant | typeof variantAsync; readonly key: string; readonly options: VariantOptionsAsync; readonly message: ErrorMessage | undefined; } /** * Variant object entries type. */ type VariantObjectEntries = Record> | OptionalEntrySchema> & ObjectEntries; /** * Variant object entries async type. */ type VariantObjectEntriesAsync = Record> | BaseSchemaAsync> | OptionalEntrySchema | OptionalEntrySchemaAsync> & ObjectEntriesAsync; /** * Variant option type. */ type VariantOption = LooseObjectSchema, ErrorMessage | undefined> | ObjectSchema, ErrorMessage | undefined> | ObjectWithRestSchema, BaseSchema>, ErrorMessage | undefined> | StrictObjectSchema, ErrorMessage | undefined> | VariantOptionSchema; /** * Variant option async type. */ type VariantOptionAsync = LooseObjectSchemaAsync, ErrorMessage | undefined> | ObjectSchemaAsync, ErrorMessage | undefined> | ObjectWithRestSchemaAsync, BaseSchema> | BaseSchemaAsync>, ErrorMessage | undefined> | StrictObjectSchemaAsync, ErrorMessage | undefined> | VariantOptionSchemaAsync; /** * Variant options type. */ type VariantOptions = MaybeReadonly[]>; /** * Variant options async type. */ type VariantOptionsAsync = MaybeReadonly<(VariantOption | VariantOptionAsync)[]>; /** * Infer variant issue type. */ type InferVariantIssue | VariantOptionsAsync> = Exclude, { type: "loose_object" | "object" | "object_with_rest"; }>; //#endregion //#region src/schemas/void/void.d.ts /** * Void issue interface. */ interface VoidIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "schema"; /** * The issue type. */ readonly type: "void"; /** * The expected property. */ readonly expected: "void"; } /** * Void schema interface. */ interface VoidSchema | undefined> extends BaseSchema { /** * The schema type. */ readonly type: "void"; /** * The schema reference. */ readonly reference: typeof void_; /** * The expected property. */ readonly expects: "void"; /** * The error message. */ readonly message: TMessage; } /** * Creates a void schema. * * @returns A void schema. */ declare function void_(): VoidSchema; /** * Creates a void schema. * * @param message The error message. * * @returns A void schema. */ declare function void_ | undefined>(message: TMessage): VoidSchema; //#endregion //#region src/actions/args/args.d.ts /** * Schema type. */ type Schema$3 = LooseTupleSchema | undefined> | StrictTupleSchema | undefined> | TupleSchema | undefined> | TupleWithRestSchema>, ErrorMessage | undefined>; /** * Args action type. */ interface ArgsAction unknown, TSchema extends Schema$3> extends BaseTransformation) => ReturnType, never> { /** * The action type. */ readonly type: "args"; /** * The action reference. */ readonly reference: typeof args; /** * The arguments schema. */ readonly schema: TSchema; } /** * Creates a function arguments transformation action. * * @param schema The arguments schema. * * @returns An args action. */ declare function args unknown, TSchema extends Schema$3>(schema: TSchema): ArgsAction; //#endregion //#region src/actions/args/argsAsync.d.ts /** * Schema type. */ type Schema$2 = LooseTupleSchema | undefined> | LooseTupleSchemaAsync | undefined> | StrictTupleSchema | undefined> | StrictTupleSchemaAsync | undefined> | TupleSchema | undefined> | TupleSchemaAsync | undefined> | TupleWithRestSchema>, ErrorMessage | undefined> | TupleWithRestSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined>; /** * Args action async type. */ interface ArgsActionAsync unknown, TSchema extends Schema$2> extends BaseTransformation) => Promise>>, never> { /** * The action type. */ readonly type: "args"; /** * The action reference. */ readonly reference: typeof argsAsync; /** * The arguments schema. */ readonly schema: TSchema; } /** * Creates a function arguments transformation action. * * @param schema The arguments schema. * * @returns An args action. */ declare function argsAsync unknown, TSchema extends Schema$2>(schema: TSchema): ArgsActionAsync; //#endregion //#region src/actions/await/awaitAsync.d.ts /** * Await action async interface. */ interface AwaitActionAsync> extends BaseTransformationAsync, never> { /** * The action type. */ readonly type: "await"; /** * The action reference. */ readonly reference: typeof awaitAsync; } /** * Creates an await transformation action. * * @returns An await action. */ declare function awaitAsync>(): AwaitActionAsync; //#endregion //#region src/actions/base64/base64.d.ts /** * Base64 issue interface. */ interface Base64Issue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "base64"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The Base64 regex. */ readonly requirement: RegExp; } /** * Base64 action interface. */ interface Base64Action> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "base64"; /** * The action reference. */ readonly reference: typeof base64; /** * The expected property. */ readonly expects: null; /** * The Base64 regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a [Base64](https://en.wikipedia.org/wiki/Base64) validation action. * * @returns A Base64 action. */ declare function base64(): Base64Action; /** * Creates a [Base64](https://en.wikipedia.org/wiki/Base64) validation action. * * @param message The error message. * * @returns A Base64 action. */ declare function base64> | undefined>(message: TMessage): Base64Action; //#endregion //#region src/actions/bic/bic.d.ts /** * BIC issue interface. */ interface BicIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "bic"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The BIC regex. */ readonly requirement: RegExp; } /** * BIC action interface. */ interface BicAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "bic"; /** * The action reference. */ readonly reference: typeof bic; /** * The expected property. */ readonly expects: null; /** * The BIC regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a [BIC](https://en.wikipedia.org/wiki/ISO_9362) validation action. * * @returns A BIC action. */ declare function bic(): BicAction; /** * Creates a [BIC](https://en.wikipedia.org/wiki/ISO_9362) validation action. * * @param message The error message. * * @returns A BIC action. */ declare function bic> | undefined>(message: TMessage): BicAction; //#endregion //#region src/actions/brand/brand.d.ts /** * Brand symbol. */ declare const BrandSymbol: unique symbol; /** * Brand name type. */ type BrandName = string | number | symbol; /** * Brand interface. */ interface Brand { [BrandSymbol]: { [TValue in TName]: TValue }; } /** * Brand action interface. */ interface BrandAction extends BaseTransformation, never> { /** * The action type. */ readonly type: "brand"; /** * The action reference. */ readonly reference: typeof brand; /** * The brand name. */ readonly name: TName; } /** * Creates a brand transformation action. * * @param name The brand name. * * @returns A brand action. */ declare function brand(name: TName): BrandAction; //#endregion //#region src/actions/bytes/bytes.d.ts /** * Bytes issue interface. */ interface BytesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "bytes"; /** * The expected property. */ readonly expected: `${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The required bytes. */ readonly requirement: TRequirement; } /** * Bytes action interface. */ interface BytesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "bytes"; /** * The action reference. */ readonly reference: typeof bytes; /** * The expected property. */ readonly expects: `${TRequirement}`; /** * The required bytes. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a [bytes](https://en.wikipedia.org/wiki/Byte) validation action. * * @param requirement The required bytes. * * @returns A bytes action. */ declare function bytes(requirement: TRequirement): BytesAction; /** * Creates a [bytes](https://en.wikipedia.org/wiki/Byte) validation action. * * @param requirement The required bytes. * @param message The error message. * * @returns A bytes action. */ declare function bytes> | undefined>(requirement: TRequirement, message: TMessage): BytesAction; //#endregion //#region src/actions/check/types.d.ts /** * Check issue interface. */ interface CheckIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "check"; /** * The expected property. */ readonly expected: null; /** * The validation function. */ readonly requirement: (input: TInput$1) => MaybePromise; } //#endregion //#region src/actions/check/check.d.ts /** * Check action interface. */ interface CheckAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "check"; /** * The action reference. */ readonly reference: typeof check; /** * The expected property. */ readonly expects: null; /** * The validation function. */ readonly requirement: (input: TInput$1) => boolean; /** * The error message. */ readonly message: TMessage; } /** * Creates a check validation action. * * @param requirement The validation function. * * @returns A check action. */ declare function check(requirement: (input: TInput$1) => boolean): CheckAction; /** * Creates a check validation action. * * @param requirement The validation function. * @param message The error message. * * @returns A check action. */ declare function check> | undefined>(requirement: (input: TInput$1) => boolean, message: TMessage): CheckAction; //#endregion //#region src/actions/check/checkAsync.d.ts /** * Check action async interface. */ interface CheckActionAsync> | undefined> extends BaseValidationAsync> { /** * The action type. */ readonly type: "check"; /** * The action reference. */ readonly reference: typeof checkAsync; /** * The expected property. */ readonly expects: null; /** * The validation function. */ readonly requirement: (input: TInput$1) => MaybePromise; /** * The error message. */ readonly message: TMessage; } /** * Creates a check validation action. * * @param requirement The validation function. * * @returns A check action. */ declare function checkAsync(requirement: (input: TInput$1) => MaybePromise): CheckActionAsync; /** * Creates a check validation action. * * @param requirement The validation function. * @param message The error message. * * @returns A check action. */ declare function checkAsync> | undefined>(requirement: (input: TInput$1) => MaybePromise, message: TMessage): CheckActionAsync; //#endregion //#region src/actions/types.d.ts /** * Array input type. */ type ArrayInput = MaybeReadonly; /** * Array requirement type. */ type ArrayRequirement = (item: TInput$1[number], index: number, array: TInput$1) => boolean; /** * Array requirement async type. */ type ArrayRequirementAsync = (item: TInput$1[number], index: number, array: TInput$1) => MaybePromise; /** * Content input type. */ type ContentInput = string | MaybeReadonly; /** * Content requirement type. */ type ContentRequirement = TInput$1 extends readonly unknown[] ? TInput$1[number] : TInput$1; /** * Entries input type. */ type EntriesInput = Record; /** * Length input type. */ type LengthInput = string | ArrayLike; /** * Size input type. */ type SizeInput = Blob | Map | Set; /** * Value input type. */ type ValueInput = string | number | bigint | boolean | Date; //#endregion //#region src/actions/checkItems/types.d.ts /** * Check items issue interface. */ interface CheckItemsIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "check_items"; /** * The expected input. */ readonly expected: null; /** * The validation function. */ readonly requirement: ArrayRequirementAsync; } //#endregion //#region src/actions/checkItems/checkItems.d.ts /** * Check items action interface. */ interface CheckItemsAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "check_items"; /** * The action reference. */ readonly reference: typeof checkItems; /** * The expected property. */ readonly expects: null; /** * The validation function. */ readonly requirement: ArrayRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates an check items validation action. * * @param requirement The validation function. * * @returns An check items action. */ declare function checkItems(requirement: ArrayRequirement): CheckItemsAction; /** * Creates an check items validation action. * * @param requirement The validation function. * @param message The error message. * * @returns An check items action. */ declare function checkItems> | undefined>(requirement: ArrayRequirement, message: TMessage): CheckItemsAction; //#endregion //#region src/actions/checkItems/checkItemsAsync.d.ts /** * Check items action async interface. */ interface CheckItemsActionAsync> | undefined> extends BaseValidationAsync> { /** * The action type. */ readonly type: "check_items"; /** * The action reference. */ readonly reference: typeof checkItemsAsync; /** * The expected property. */ readonly expects: null; /** * The validation function. */ readonly requirement: ArrayRequirementAsync; /** * The error message. */ readonly message: TMessage; } /** * Creates a check items validation action. * * @param requirement The validation function. * * @returns A check items action. */ declare function checkItemsAsync(requirement: ArrayRequirementAsync): CheckItemsActionAsync; /** * Creates a check items validation action. * * @param requirement The validation function. * @param message The error message. * * @returns A check items action. */ declare function checkItemsAsync> | undefined>(requirement: ArrayRequirementAsync, message: TMessage): CheckItemsActionAsync; //#endregion //#region src/actions/creditCard/creditCard.d.ts /** * Credit card issue interface. */ interface CreditCardIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "credit_card"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The validation function. */ readonly requirement: (input: string) => boolean; } /** * Credit card action interface. */ interface CreditCardAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "credit_card"; /** * The action reference. */ readonly reference: typeof creditCard; /** * The expected property. */ readonly expects: null; /** * The validation function. */ readonly requirement: (input: string) => boolean; /** * The error message. */ readonly message: TMessage; } /** * Creates a [credit card](https://en.wikipedia.org/wiki/Payment_card_number) validation action. * * @returns A Credit card action. */ declare function creditCard(): CreditCardAction; /** * Creates a [credit card](https://en.wikipedia.org/wiki/Payment_card_number) validation action. * * @param message The error message. * * @returns A credit card action. */ declare function creditCard> | undefined>(message: TMessage): CreditCardAction; //#endregion //#region src/actions/cuid2/cuid2.d.ts /** * Cuid2 issue interface. */ interface Cuid2Issue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "cuid2"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The Cuid2 regex. */ readonly requirement: RegExp; } /** * Cuid2 action interface. */ interface Cuid2Action> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "cuid2"; /** * The action reference. */ readonly reference: typeof cuid2; /** * The expected property. */ readonly expects: null; /** * The Cuid2 regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a [Cuid2](https://github.com/paralleldrive/cuid2) validation action. * * @returns A Cuid2 action. */ declare function cuid2(): Cuid2Action; /** * Creates a [Cuid2](https://github.com/paralleldrive/cuid2) validation action. * * @param message The error message. * * @returns A Cuid2 action. */ declare function cuid2> | undefined>(message: TMessage): Cuid2Action; //#endregion //#region src/actions/decimal/decimal.d.ts /** * Decimal issue interface. */ interface DecimalIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "decimal"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The decimal regex. */ readonly requirement: RegExp; } /** * Decimal action interface. */ interface DecimalAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "decimal"; /** * The action reference. */ readonly reference: typeof decimal; /** * The expected property. */ readonly expects: null; /** * The decimal regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a [decimal](https://en.wikipedia.org/wiki/Decimal) validation action. * * The difference between `decimal` and `digits` is that `decimal` accepts * floating point numbers and negative numbers, while `digits` accepts only the * digits 0-9. * * @returns An decimal action. */ declare function decimal(): DecimalAction; /** * Creates a [decimal](https://en.wikipedia.org/wiki/Decimal) validation action. * * The difference between `decimal` and `digits` is that `decimal` accepts * floating point numbers and negative numbers, while `digits` accepts only the * digits 0-9. * * @param message The error message. * * @returns An decimal action. */ declare function decimal> | undefined>(message: TMessage): DecimalAction; //#endregion //#region src/actions/description/description.d.ts /** * Description action interface. */ interface DescriptionAction extends BaseMetadata { /** * The action type. */ readonly type: "description"; /** * The action reference. */ readonly reference: typeof description; /** * The description text. */ readonly description: TDescription; } /** * Creates a description metadata action. * * @param description_ The description text. * * @returns A description action. */ declare function description(description_: TDescription): DescriptionAction; //#endregion //#region src/actions/digits/digits.d.ts /** * Digits issue interface. */ interface DigitsIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "digits"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The digits regex. */ readonly requirement: RegExp; } /** * Digits action interface. */ interface DigitsAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "digits"; /** * The action reference. */ readonly reference: typeof digits; /** * The expected property. */ readonly expects: null; /** * The digits regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a [digits](https://en.wikipedia.org/wiki/Numerical_digit) validation action. * * The difference between `digits` and `decimal` is that `digits` accepts only * the digits 0-9, while `decimal` accepts floating point numbers and negative * numbers. * * @returns An digits action. */ declare function digits(): DigitsAction; /** * Creates a [digits](https://en.wikipedia.org/wiki/Numerical_digit) validation action. * * The difference between `digits` and `decimal` is that `digits` accepts only * the digits 0-9, while `decimal` accepts floating point numbers and negative * numbers. * * @param message The error message. * * @returns An digits action. */ declare function digits> | undefined>(message: TMessage): DigitsAction; //#endregion //#region src/actions/email/email.d.ts /** * Email issue interface. */ interface EmailIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "email"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The email regex. */ readonly requirement: RegExp; } /** * Email action interface. */ interface EmailAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "email"; /** * The action reference. */ readonly reference: typeof email; /** * The expected property. */ readonly expects: null; /** * The email regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [email](https://en.wikipedia.org/wiki/Email_address) validation * action. * * Hint: This validation action intentionally only validates common email * addresses. If you are interested in an action that covers the entire * specification, please use the `rfcEmail` action instead. * * @returns An email action. */ declare function email(): EmailAction; /** * Creates an [email](https://en.wikipedia.org/wiki/Email_address) validation * action. * * Hint: This validation action intentionally only validates common email * addresses. If you are interested in an action that covers the entire * specification, please use the `rfcEmail` action instead. * * @param message The error message. * * @returns An email action. */ declare function email> | undefined>(message: TMessage): EmailAction; //#endregion //#region src/actions/emoji/emoji.d.ts /** * Emoji issue interface. */ interface EmojiIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "emoji"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The emoji regex. */ readonly requirement: RegExp; } /** * Emoji action interface. */ interface EmojiAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "emoji"; /** * The action reference. */ readonly reference: typeof emoji; /** * The expected property. */ readonly expects: null; /** * The emoji regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [emoji](https://en.wikipedia.org/wiki/Emoji) validation action. * * @returns An emoji action. */ declare function emoji(): EmojiAction; /** * Creates an [emoji](https://en.wikipedia.org/wiki/Emoji) validation action. * * @param message The error message. * * @returns An emoji action. */ declare function emoji> | undefined>(message: TMessage): EmojiAction; //#endregion //#region src/actions/empty/empty.d.ts /** * Empty issue interface. */ interface EmptyIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "empty"; /** * The expected input. */ readonly expected: "0"; /** * The received input. */ readonly received: `${number}`; } /** * Empty action interface. */ interface EmptyAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "empty"; /** * The action reference. */ readonly reference: typeof empty; /** * The expected property. */ readonly expects: "0"; /** * The error message. */ readonly message: TMessage; } /** * Creates an empty validation action. * * @returns An empty action. */ declare function empty(): EmptyAction; /** * Creates an empty validation action. * * @param message The error message. * * @returns An empty action. */ declare function empty> | undefined>(message: TMessage): EmptyAction; //#endregion //#region src/actions/endsWith/endsWith.d.ts /** * Ends with issue interface. */ interface EndsWithIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "ends_with"; /** * The expected property. */ readonly expected: `"${TRequirement}"`; /** * The received property. */ readonly received: `"${string}"`; /** * The end string. */ readonly requirement: TRequirement; } /** * Ends with action interface. */ interface EndsWithAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "ends_with"; /** * The action reference. */ readonly reference: typeof endsWith; /** * The expected property. */ readonly expects: `"${TRequirement}"`; /** * The end string. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates an ends with validation action. * * @param requirement The end string. * * @returns An ends with action. */ declare function endsWith(requirement: TRequirement): EndsWithAction; /** * Creates an ends with validation action. * * @param requirement The end string. * @param message The error message. * * @returns An ends with action. */ declare function endsWith> | undefined>(requirement: TRequirement, message: TMessage): EndsWithAction; //#endregion //#region src/actions/entries/entries.d.ts /** * Entries issue interface. * * @beta */ interface EntriesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "entries"; /** * The expected property. */ readonly expected: `${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The required entries. */ readonly requirement: TRequirement; } /** * Entries action interface. * * @beta */ interface EntriesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "entries"; /** * The action reference. */ readonly reference: typeof entries; /** * The expected property. */ readonly expects: `${TRequirement}`; /** * The required entries. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates an entries validation action. * * @param requirement The required entries. * * @returns An entries action. * * @beta */ declare function entries(requirement: TRequirement): EntriesAction; /** * Creates an entries validation action. * * @param requirement The required entries. * @param message The error message. * * @returns An entries action. * * @beta */ declare function entries> | undefined>(requirement: TRequirement, message: TMessage): EntriesAction; //#endregion //#region src/actions/everyItem/everyItem.d.ts /** * Every item issue interface. */ interface EveryItemIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "every_item"; /** * The expected property. */ readonly expected: null; /** * The validation function. */ readonly requirement: ArrayRequirement; } /** * Every item action interface. */ interface EveryItemAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "every_item"; /** * The action reference. */ readonly reference: typeof everyItem; /** * The expected property. */ readonly expects: null; /** * The validation function. */ readonly requirement: ArrayRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates an every item validation action. * * @param requirement The validation function. * * @returns An every item action. */ declare function everyItem(requirement: ArrayRequirement): EveryItemAction; /** * Creates an every item validation action. * * @param requirement The validation function. * @param message The error message. * * @returns An every item action. */ declare function everyItem> | undefined>(requirement: ArrayRequirement, message: TMessage): EveryItemAction; //#endregion //#region src/actions/examples/examples.d.ts /** * Examples action interface. */ interface ExamplesAction extends BaseMetadata { /** * The action type. */ readonly type: "examples"; /** * The action reference. */ readonly reference: typeof examples; /** * The examples. */ readonly examples: TExamples; } /** * Creates an examples metadata action. * * @param examples_ The examples. * * @returns An examples action. * * @beta */ declare function examples(examples_: TExamples): ExamplesAction; //#endregion //#region src/actions/excludes/excludes.d.ts /** * Excludes issue interface. */ interface ExcludesIssue> extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "excludes"; /** * The expected property. */ readonly expected: string; /** * The content to be excluded. */ readonly requirement: TRequirement; } /** * Excludes action interface. */ interface ExcludesAction, TMessage extends ErrorMessage> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "excludes"; /** * The action reference. */ readonly reference: typeof excludes; /** * The expected property. */ readonly expects: string; /** * The content to be excluded. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates an excludes validation action. * * @param requirement The content to be excluded. * * @returns An excludes action. */ declare function excludes>(requirement: TRequirement): ExcludesAction; /** * Creates an excludes validation action. * * @param requirement The content to be excluded. * @param message The error message. * * @returns An excludes action. */ declare function excludes, const TMessage extends ErrorMessage> | undefined>(requirement: TRequirement, message: TMessage): ExcludesAction; //#endregion //#region src/actions/filterItems/filterItems.d.ts /** * Filter items action interface. */ interface FilterItemsAction extends BaseTransformation { /** * The action type. */ readonly type: "filter_items"; /** * The action reference. */ readonly reference: typeof filterItems; /** * The filter items operation. */ readonly operation: ArrayRequirement; } /** * Creates a filter items transformation action. * * @param operation The filter items operation. * * @returns A filter items action. */ declare function filterItems(operation: ArrayRequirement): FilterItemsAction; //#endregion //#region src/actions/findItem/findItem.d.ts /** * Array requirement type. */ type ArrayRequirement$1 = ((item: TInput$1[number], index: number, array: TInput$1) => item is TOuput) | ((item: TInput$1[number], index: number, array: TInput$1) => boolean); /** * Find item action interface. */ interface FindItemAction extends BaseTransformation { /** * The action type. */ readonly type: "find_item"; /** * The action reference. */ readonly reference: typeof findItem; /** * The find item operation. */ readonly operation: ArrayRequirement$1; } /** * Creates a find item transformation action. * * @param operation The find item operation. * * @returns A find item action. */ declare function findItem(operation: ArrayRequirement$1): FindItemAction; //#endregion //#region src/actions/finite/finite.d.ts /** * Finite issue interface. */ interface FiniteIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "finite"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `${number}`; /** * The validation function. */ readonly requirement: (input: number) => boolean; } /** * Finite action interface. */ interface FiniteAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "finite"; /** * The action reference. */ readonly reference: typeof finite; /** * The expected property. */ readonly expects: null; /** * The validation function. */ readonly requirement: (input: number) => boolean; /** * The error message. */ readonly message: TMessage; } /** * Creates a [finite](https://en.wikipedia.org/wiki/Finite) validation action. * * @returns A finite action. */ declare function finite(): FiniteAction; /** * Creates a [finite](https://en.wikipedia.org/wiki/Finite) validation action. * * @param message The error message. * * @returns A finite action. */ declare function finite> | undefined>(message: TMessage): FiniteAction; //#endregion //#region src/actions/flavor/flavor.d.ts /** * Flavor symbol. * * @beta */ declare const FlavorSymbol: unique symbol; /** * Flavor name type. * * @beta */ type FlavorName = string | number | symbol; /** * Flavor interface. * * @beta */ interface Flavor { [FlavorSymbol]?: { [TValue in TName]: TValue }; } /** * Flavor action interface. * * @beta */ interface FlavorAction extends BaseTransformation, never> { /** * The action type. */ readonly type: "flavor"; /** * The action reference. */ readonly reference: typeof flavor; /** * The flavor name. */ readonly name: TName; } /** * Creates a flavor transformation action. * * @param name The flavor name. * * @returns A flavor action. * * @beta */ declare function flavor(name: TName): FlavorAction; //#endregion //#region src/actions/graphemes/graphemes.d.ts /** * Graphemes issue interface. */ interface GraphemesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "graphemes"; /** * The expected property. */ readonly expected: `${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The required graphemes. */ readonly requirement: TRequirement; } /** * Graphemes action interface. */ interface GraphemesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "graphemes"; /** * The action reference. */ readonly reference: typeof graphemes; /** * The expected property. */ readonly expects: `${TRequirement}`; /** * The required graphemes. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a graphemes validation action. * * @param requirement The required graphemes. * * @returns A graphemes action. */ declare function graphemes(requirement: TRequirement): GraphemesAction; /** * Creates a graphemes validation action. * * @param requirement The required graphemes. * @param message The error message. * * @returns A graphemes action. */ declare function graphemes> | undefined>(requirement: TRequirement, message: TMessage): GraphemesAction; //#endregion //#region src/actions/gtValue/gtValue.d.ts /** * Greater than value issue type. */ interface GtValueIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "gt_value"; /** * The expected property. */ readonly expected: `>${string}`; /** * The greater than value. */ readonly requirement: TRequirement; } /** * Greater than value action type. */ interface GtValueAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "gt_value"; /** * The action reference. */ readonly reference: typeof gtValue; /** * The expected property. */ readonly expects: `>${string}`; /** * The greater than value. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a greater than value validation action. * * @param requirement The greater than value. * * @returns A greater than value action. */ declare function gtValue(requirement: TRequirement): GtValueAction; /** * Creates a greater than value validation action. * * @param requirement The greater than value. * @param message The error message. * * @returns A greater than value action. */ declare function gtValue> | undefined>(requirement: TRequirement, message: TMessage): GtValueAction; //#endregion //#region src/actions/hash/hash.d.ts /** * Hash lengths object. */ declare const HASH_LENGTHS: { readonly md4: 32; readonly md5: 32; readonly sha1: 40; readonly sha256: 64; readonly sha384: 96; readonly sha512: 128; readonly ripemd128: 32; readonly ripemd160: 40; readonly tiger128: 32; readonly tiger160: 40; readonly tiger192: 48; readonly crc32: 8; readonly crc32b: 8; readonly adler32: 8; }; /** * Hash type type. */ type HashType = keyof typeof HASH_LENGTHS; /** * Hash issue interface. */ interface HashIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "hash"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The hash regex. */ readonly requirement: RegExp; } /** * Hash action interface. */ interface HashAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "hash"; /** * The action reference. */ readonly reference: typeof hash; /** * The expected property. */ readonly expects: null; /** * The hash regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a [hash](https://en.wikipedia.org/wiki/Hash_function) validation action. * * @param types The hash types. * * @returns A hash action. */ declare function hash(types: [HashType, ...HashType[]]): HashAction; /** * Creates a [hash](https://en.wikipedia.org/wiki/Hash_function) validation action. * * @param types The hash types. * @param message The error message. * * @returns A hash action. */ declare function hash> | undefined>(types: [HashType, ...HashType[]], message: TMessage): HashAction; //#endregion //#region src/actions/hexadecimal/hexadecimal.d.ts /** * Hexadecimal issue interface. */ interface HexadecimalIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "hexadecimal"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The hexadecimal regex. */ readonly requirement: RegExp; } /** * Hexadecimal action interface. */ interface HexadecimalAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "hexadecimal"; /** * The action reference. */ readonly reference: typeof hexadecimal; /** * The expected property. */ readonly expects: null; /** * The hexadecimal regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a [hexadecimal](https://en.wikipedia.org/wiki/Hexadecimal) validation action. * * @returns A hexadecimal action. */ declare function hexadecimal(): HexadecimalAction; /** * Creates a [hexadecimal](https://en.wikipedia.org/wiki/Hexadecimal) validation action. * * @param message The error message. * * @returns A hexadecimal action. */ declare function hexadecimal> | undefined>(message: TMessage): HexadecimalAction; //#endregion //#region src/actions/hexColor/hexColor.d.ts /** * Hex color issue interface. */ interface HexColorIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "hex_color"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The hex color regex. */ readonly requirement: RegExp; } /** * Hex color action interface. */ interface HexColorAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "hex_color"; /** * The action reference. */ readonly reference: typeof hexColor; /** * The expected property. */ readonly expects: null; /** * The hex color regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a [hex color](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet) validation action. * * @returns A hex color action. */ declare function hexColor(): HexColorAction; /** * Creates a [hex color](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet) validation action. * * @param message The error message. * * @returns A hex color action. */ declare function hexColor> | undefined>(message: TMessage): HexColorAction; //#endregion //#region src/actions/imei/imei.d.ts /** * IMEI issue interface. */ interface ImeiIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "imei"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The validation function. */ readonly requirement: (input: string) => boolean; } /** * IMEI action interface. */ interface ImeiAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "imei"; /** * The action reference. */ readonly reference: typeof imei; /** * The expected property. */ readonly expects: null; /** * The validation function. */ readonly requirement: (input: string) => boolean; /** * The error message. */ readonly message: TMessage; } /** * Creates an [IMEI](https://en.wikipedia.org/wiki/International_Mobile_Equipment_Identity) validation action. * * Formats: * - AABBBBBBCCCCCCD * - AA-BBBBBB-CCCCCC-D * * @returns An IMEI action. */ declare function imei(): ImeiAction; /** * Creates an [IMEI](https://en.wikipedia.org/wiki/International_Mobile_Equipment_Identity) validation action. * * Formats: * - AABBBBBBCCCCCCD * - AA-BBBBBB-CCCCCC-D * * @param message The error message. * * @returns An IMEI action. */ declare function imei> | undefined>(message: TMessage): ImeiAction; //#endregion //#region src/actions/includes/includes.d.ts /** * Includes issue interface. */ interface IncludesIssue> extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "includes"; /** * The expected property. */ readonly expected: string; /** * The content to be included. */ readonly requirement: TRequirement; } /** * Includes action interface. */ interface IncludesAction, TMessage extends ErrorMessage> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "includes"; /** * The action reference. */ readonly reference: typeof includes; /** * The expected property. */ readonly expects: string; /** * The content to be included. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates an includes validation action. * * @param requirement The content to be included. * * @returns An includes action. */ declare function includes>(requirement: TRequirement): IncludesAction; /** * Creates an includes validation action. * * @param requirement The content to be included. * @param message The error message. * * @returns An includes action. */ declare function includes, const TMessage extends ErrorMessage> | undefined>(requirement: TRequirement, message: TMessage): IncludesAction; //#endregion //#region src/actions/integer/integer.d.ts /** * Integer issue interface. */ interface IntegerIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "integer"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `${number}`; /** * The validation function. */ readonly requirement: (input: number) => boolean; } /** * Integer action interface. */ interface IntegerAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "integer"; /** * The action reference. */ readonly reference: typeof integer; /** * The expected property. */ readonly expects: null; /** * The validation function. */ readonly requirement: (input: number) => boolean; /** * The error message. */ readonly message: TMessage; } /** * Creates an [integer](https://en.wikipedia.org/wiki/Integer) validation action. * * @returns An integer action. */ declare function integer(): IntegerAction; /** * Creates an [integer](https://en.wikipedia.org/wiki/Integer) validation action. * * @param message The error message. * * @returns An integer action. */ declare function integer> | undefined>(message: TMessage): IntegerAction; //#endregion //#region src/actions/ip/ip.d.ts /** * IP issue interface. */ interface IpIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "ip"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The IP regex. */ readonly requirement: RegExp; } /** * IP action interface. */ interface IpAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "ip"; /** * The action reference. */ readonly reference: typeof ip; /** * The expected property. */ readonly expects: null; /** * The IP regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [IP address](https://en.wikipedia.org/wiki/IP_address) validation action. * * @returns An IP action. */ declare function ip(): IpAction; /** * Creates an [IP address](https://en.wikipedia.org/wiki/IP_address) validation action. * * @param message The error message. * * @returns An IP action. */ declare function ip> | undefined>(message: TMessage): IpAction; //#endregion //#region src/actions/ipv4/ipv4.d.ts /** * IPv4 issue interface. */ interface Ipv4Issue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "ipv4"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The IPv4 regex. */ readonly requirement: RegExp; } /** * IPv4 action interface. */ interface Ipv4Action> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "ipv4"; /** * The action reference. */ readonly reference: typeof ipv4; /** * The expected property. */ readonly expects: null; /** * The IPv4 regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [IPv4](https://en.wikipedia.org/wiki/IPv4) address validation action. * * @returns An IPv4 action. */ declare function ipv4(): Ipv4Action; /** * Creates an [IPv4](https://en.wikipedia.org/wiki/IPv4) address validation action. * * @param message The error message. * * @returns An IPv4 action. */ declare function ipv4> | undefined>(message: TMessage): Ipv4Action; //#endregion //#region src/actions/ipv6/ipv6.d.ts /** * IPv6 issue interface. */ interface Ipv6Issue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "ipv6"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The IPv6 regex. */ readonly requirement: RegExp; } /** * IPv6 action interface. */ interface Ipv6Action> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "ipv6"; /** * The action reference. */ readonly reference: typeof ipv6; /** * The expected property. */ readonly expects: null; /** * The IPv6 regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [IPv6](https://en.wikipedia.org/wiki/IPv6) address validation action. * * @returns An IPv6 action. */ declare function ipv6(): Ipv6Action; /** * Creates an [IPv6](https://en.wikipedia.org/wiki/IPv6) address validation action. * * @param message The error message. * * @returns An IPv6 action. */ declare function ipv6> | undefined>(message: TMessage): Ipv6Action; //#endregion //#region src/actions/isoDate/isoDate.d.ts /** * ISO date issue interface. */ interface IsoDateIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "iso_date"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The ISO date regex. */ readonly requirement: RegExp; } /** * ISO date action interface. */ interface IsoDateAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "iso_date"; /** * The action reference. */ readonly reference: typeof isoDate; /** * The expected property. */ readonly expects: null; /** * The ISO date regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [ISO date](https://en.wikipedia.org/wiki/ISO_8601) validation action. * * Format: yyyy-mm-dd * * Hint: The regex used cannot validate the maximum number of days based on * year and month. For example, "2023-06-31" is valid although June has only * 30 days. * * @returns An ISO date action. */ declare function isoDate(): IsoDateAction; /** * Creates an [ISO date](https://en.wikipedia.org/wiki/ISO_8601) validation action. * * Format: yyyy-mm-dd * * Hint: The regex used cannot validate the maximum number of days based on * year and month. For example, "2023-06-31" is valid although June has only * 30 days. * * @param message The error message. * * @returns An ISO date action. */ declare function isoDate> | undefined>(message: TMessage): IsoDateAction; //#endregion //#region src/actions/isoDateTime/isoDateTime.d.ts /** * ISO date time issue interface. */ interface IsoDateTimeIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "iso_date_time"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The ISO date time regex. */ readonly requirement: RegExp; } /** * ISO date time action interface. */ interface IsoDateTimeAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "iso_date_time"; /** * The action reference. */ readonly reference: typeof isoDateTime; /** * The expected property. */ readonly expects: null; /** * The ISO date time regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [ISO date time](https://en.wikipedia.org/wiki/ISO_8601) validation action. * * Format: yyyy-mm-ddThh:mm * * Hint: The regex used cannot validate the maximum number of days based on * year and month. For example, "2023-06-31T00:00" is valid although June has only * 30 days. * * Hint: The regex also allows a space as a separator between the date and time * parts instead of the "T" character. * * @returns An ISO date time action. */ declare function isoDateTime(): IsoDateTimeAction; /** * Creates an [ISO date time](https://en.wikipedia.org/wiki/ISO_8601) validation action. * * Format: yyyy-mm-ddThh:mm * * Hint: The regex used cannot validate the maximum number of days based on * year and month. For example, "2023-06-31T00:00" is valid although June has only * 30 days. * * Hint: The regex also allows a space as a separator between the date and time * parts instead of the "T" character. * * @param message The error message. * * @returns An ISO date time action. */ declare function isoDateTime> | undefined>(message: TMessage): IsoDateTimeAction; //#endregion //#region src/actions/isoTime/isoTime.d.ts /** * ISO time issue interface. */ interface IsoTimeIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "iso_time"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The ISO time regex. */ readonly requirement: RegExp; } /** * ISO time action interface. */ interface IsoTimeAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "iso_time"; /** * The action reference. */ readonly reference: typeof isoTime; /** * The expected property. */ readonly expects: null; /** * The ISO time regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [ISO time](https://en.wikipedia.org/wiki/ISO_8601) validation action. * * Format: hh:mm * * @returns An ISO time action. */ declare function isoTime(): IsoTimeAction; /** * Creates an [ISO time](https://en.wikipedia.org/wiki/ISO_8601) validation action. * * Format: hh:mm * * @param message The error message. * * @returns An ISO time action. */ declare function isoTime> | undefined>(message: TMessage): IsoTimeAction; //#endregion //#region src/actions/isoTimeSecond/isoTimeSecond.d.ts /** * ISO time second issue interface. */ interface IsoTimeSecondIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "iso_time_second"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The ISO time with seconds regex. */ readonly requirement: RegExp; } /** * ISO time second action interface. */ interface IsoTimeSecondAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "iso_time_second"; /** * The action reference. */ readonly reference: typeof isoTimeSecond; /** * The expected property. */ readonly expects: null; /** * The ISO time second regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [ISO time second](https://en.wikipedia.org/wiki/ISO_8601) validation action. * * Format: hh:mm:ss * * @returns An ISO time second action. */ declare function isoTimeSecond(): IsoTimeSecondAction; /** * Creates an [ISO time second](https://en.wikipedia.org/wiki/ISO_8601) validation action. * * Format: hh:mm:ss * * @param message The error message. * * @returns An ISO time second action. */ declare function isoTimeSecond> | undefined>(message: TMessage): IsoTimeSecondAction; //#endregion //#region src/actions/isoTimestamp/isoTimestamp.d.ts /** * ISO timestamp issue interface. */ interface IsoTimestampIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "iso_timestamp"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The ISO timestamp regex. */ readonly requirement: RegExp; } /** * ISO timestamp action interface. */ interface IsoTimestampAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "iso_timestamp"; /** * The action reference. */ readonly reference: typeof isoTimestamp; /** * The expected property. */ readonly expects: null; /** * The ISO timestamp regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [ISO timestamp](https://en.wikipedia.org/wiki/ISO_8601) validation * action. * * Formats: * - yyyy-mm-ddThh:mm:ss.sssZ * - yyyy-mm-ddThh:mm:ss.sss±hh:mm * - yyyy-mm-ddThh:mm:ss.sss±hhmm * * Hint: To support timestamps with lower or higher accuracy, the millisecond * specification can be removed or contain up to 9 digits. * * Hint: The regex used cannot validate the maximum number of days based on * year and month. For example, "2023-06-31T00:00:00.000Z" is valid although * June has only 30 days. * * Hint: The regex also allows a space as a separator between the date and time * parts instead of the "T" character. * * @returns An ISO timestamp action. */ declare function isoTimestamp(): IsoTimestampAction; /** * Creates an [ISO timestamp](https://en.wikipedia.org/wiki/ISO_8601) validation * action. * * Formats: * - yyyy-mm-ddThh:mm:ss.sssZ * - yyyy-mm-ddThh:mm:ss.sss±hh:mm * - yyyy-mm-ddThh:mm:ss.sss±hhmm * - yyyy-mm-ddThh:mm:ss.sss±hh * * Hint: To support timestamps with lower or higher accuracy, the millisecond * specification can be removed or contain up to 9 digits. * * Hint: The regex used cannot validate the maximum number of days based on * year and month. For example, "2023-06-31T00:00:00.000Z" is valid although * June has only 30 days. * * Hint: The regex also allows a space as a separator between the date and time * parts instead of the "T" character. * * @param message The error message. * * @returns An ISO timestamp action. */ declare function isoTimestamp> | undefined>(message: TMessage): IsoTimestampAction; //#endregion //#region src/actions/isoWeek/isoWeek.d.ts /** * ISO week issue interface. */ interface IsoWeekIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "iso_week"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The ISO week regex. */ readonly requirement: RegExp; } /** * ISO week action interface. */ interface IsoWeekAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "iso_week"; /** * The action reference. */ readonly reference: typeof isoWeek; /** * The expected property. */ readonly expects: null; /** * The ISO week regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [ISO week](https://en.wikipedia.org/wiki/ISO_8601) validation action. * * Format: yyyy-Www * * Hint: The regex used cannot validate the maximum number of weeks based on * the year. For example, "2021W53" is valid although 2021 has only 52 weeks. * * @returns An ISO week action. */ declare function isoWeek(): IsoWeekAction; /** * Creates an [ISO week](https://en.wikipedia.org/wiki/ISO_8601) validation action. * * Format: yyyy-Www * * Hint: The regex used cannot validate the maximum number of weeks based on * the year. For example, "2021W53" is valid although 2021 has only 52 weeks. * * @param message The error message. * * @returns An ISO week action. */ declare function isoWeek> | undefined>(message: TMessage): IsoWeekAction; //#endregion //#region src/actions/length/length.d.ts /** * Length issue interface. */ interface LengthIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "length"; /** * The expected property. */ readonly expected: `${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The required length. */ readonly requirement: TRequirement; } /** * Length action interface. */ interface LengthAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "length"; /** * The action reference. */ readonly reference: typeof length; /** * The expected property. */ readonly expects: `${TRequirement}`; /** * The required length. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a length validation action. * * @param requirement The required length. * * @returns A length action. */ declare function length(requirement: TRequirement): LengthAction; /** * Creates a length validation action. * * @param requirement The required length. * @param message The error message. * * @returns A length action. */ declare function length> | undefined>(requirement: TRequirement, message: TMessage): LengthAction; //#endregion //#region src/actions/ltValue/ltValue.d.ts /** * Less than value issue type. */ interface LtValueIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "lt_value"; /** * The expected property. */ readonly expected: `<${string}`; /** * The less than value. */ readonly requirement: TRequirement; } /** * Less than value action type. */ interface LtValueAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "lt_value"; /** * The action reference. */ readonly reference: typeof ltValue; /** * The expected property. */ readonly expects: `<${string}`; /** * The less than value. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a less than value validation action. * * @param requirement The less than value. * * @returns A less than value action. */ declare function ltValue(requirement: TRequirement): LtValueAction; /** * Creates a less than value validation action. * * @param requirement The less than value. * @param message The error message. * * @returns A less than value action. */ declare function ltValue> | undefined>(requirement: TRequirement, message: TMessage): LtValueAction; //#endregion //#region src/actions/mac/mac.d.ts /** * MAC issue interface. */ interface MacIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "mac"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The MAC regex. */ readonly requirement: RegExp; } /** * MAC action interface. */ interface MacAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "mac"; /** * The action reference. */ readonly reference: typeof mac; /** * The expected property. */ readonly expects: null; /** * The MAC regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a [MAC address](https://en.wikipedia.org/wiki/MAC_address) validation action. * * @returns A MAC action. */ declare function mac(): MacAction; /** * Creates a [MAC address](https://en.wikipedia.org/wiki/MAC_address) validation action. * * @param message The error message. * * @returns A MAC action. */ declare function mac> | undefined>(message: TMessage): MacAction; //#endregion //#region src/actions/mac48/mac48.d.ts /** * 48-bit MAC issue interface. */ interface Mac48Issue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "mac48"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The 48-bit MAC regex. */ readonly requirement: RegExp; } /** * 48-bit MAC action interface. */ interface Mac48Action> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "mac48"; /** * The action reference. */ readonly reference: typeof mac48; /** * The expected property. */ readonly expects: null; /** * The 48-bit MAC regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a 48-bit [MAC address](https://en.wikipedia.org/wiki/MAC_address) validation action. * * @returns A 48-bit MAC action. */ declare function mac48(): Mac48Action; /** * Creates a 48-bit [MAC address](https://en.wikipedia.org/wiki/MAC_address) validation action. * * @param message The error message. * * @returns A 48-bit MAC action. */ declare function mac48> | undefined>(message: TMessage): Mac48Action; //#endregion //#region src/actions/mac64/mac64.d.ts /** * 64-bit MAC issue interface. */ interface Mac64Issue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "mac64"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The 64-bit MAC regex. */ readonly requirement: RegExp; } /** * 64-bit MAC action interface. */ interface Mac64Action> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "mac64"; /** * The action reference. */ readonly reference: typeof mac64; /** * The expected property. */ readonly expects: null; /** * The 64-bit MAC regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a 64-bit [MAC address](https://en.wikipedia.org/wiki/MAC_address) validation action. * * @returns A 64-bit MAC action. */ declare function mac64(): Mac64Action; /** * Creates a 64-bit [MAC address](https://en.wikipedia.org/wiki/MAC_address) validation action. * * @param message The error message. * * @returns A 64-bit MAC action. */ declare function mac64> | undefined>(message: TMessage): Mac64Action; //#endregion //#region src/actions/mapItems/mapItems.d.ts /** * Array action type. */ type ArrayAction$2 = (item: TInput$1[number], index: number, array: TInput$1) => TOutput$1; /** * Map items action interface. */ interface MapItemsAction extends BaseTransformation { /** * The action type. */ readonly type: "map_items"; /** * The action reference. */ readonly reference: typeof mapItems; /** * The map items operation. */ readonly operation: ArrayAction$2; } /** * Creates a map items transformation action. * * @param operation The map items operation. * * @returns A map items action. */ declare function mapItems(operation: ArrayAction$2): MapItemsAction; //#endregion //#region src/actions/maxBytes/maxBytes.d.ts /** * Max bytes issue interface. */ interface MaxBytesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "max_bytes"; /** * The expected property. */ readonly expected: `<=${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The maximum bytes. */ readonly requirement: TRequirement; } /** * Max bytes action interface. */ interface MaxBytesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "max_bytes"; /** * The action reference. */ readonly reference: typeof maxBytes; /** * The expected property. */ readonly expects: `<=${TRequirement}`; /** * The maximum bytes. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a max [bytes](https://en.wikipedia.org/wiki/Byte) validation action. * * @param requirement The maximum bytes. * * @returns A max bytes action. */ declare function maxBytes(requirement: TRequirement): MaxBytesAction; /** * Creates a max [bytes](https://en.wikipedia.org/wiki/Byte) validation action. * * @param requirement The maximum bytes. * @param message The error message. * * @returns A max bytes action. */ declare function maxBytes> | undefined>(requirement: TRequirement, message: TMessage): MaxBytesAction; //#endregion //#region src/actions/maxEntries/maxEntries.d.ts /** * Max entries issue interface. * * @beta */ interface MaxEntriesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "max_entries"; /** * The expected property. */ readonly expected: `<=${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The maximum entries. */ readonly requirement: TRequirement; } /** * Max entries action interface. * * @beta */ interface MaxEntriesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "max_entries"; /** * The action reference. */ readonly reference: typeof maxEntries; /** * The expected property. */ readonly expects: `<=${TRequirement}`; /** * The maximum entries. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a max entries validation action. * * @param requirement The maximum entries. * * @returns A max entries action. * * @beta */ declare function maxEntries(requirement: TRequirement): MaxEntriesAction; /** * Creates a max entries validation action. * * @param requirement The maximum entries. * @param message The error message. * * @returns A max entries action. * * @beta */ declare function maxEntries> | undefined>(requirement: TRequirement, message: TMessage): MaxEntriesAction; //#endregion //#region src/actions/maxGraphemes/maxGraphemes.d.ts /** * Max graphemes issue interface. */ interface MaxGraphemesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "max_graphemes"; /** * The expected property. */ readonly expected: `<=${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The maximum graphemes. */ readonly requirement: TRequirement; } /** * Max graphemes action interface. */ interface MaxGraphemesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "max_graphemes"; /** * The action reference. */ readonly reference: typeof maxGraphemes; /** * The expected property. */ readonly expects: `<=${TRequirement}`; /** * The maximum graphemes. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a max graphemes validation action. * * @param requirement The maximum graphemes. * * @returns A max graphemes action. */ declare function maxGraphemes(requirement: TRequirement): MaxGraphemesAction; /** * Creates a max graphemes validation action. * * @param requirement The maximum graphemes. * @param message The error message. * * @returns A max graphemes action. */ declare function maxGraphemes> | undefined>(requirement: TRequirement, message: TMessage): MaxGraphemesAction; //#endregion //#region src/actions/maxLength/maxLength.d.ts /** * Max length issue interface. */ interface MaxLengthIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "max_length"; /** * The expected property. */ readonly expected: `<=${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The maximum length. */ readonly requirement: TRequirement; } /** * Max length action interface. */ interface MaxLengthAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "max_length"; /** * The action reference. */ readonly reference: typeof maxLength; /** * The expected property. */ readonly expects: `<=${TRequirement}`; /** * The maximum length. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a max length validation action. * * @param requirement The maximum length. * * @returns A max length action. */ declare function maxLength(requirement: TRequirement): MaxLengthAction; /** * Creates a max length validation action. * * @param requirement The maximum length. * @param message The error message. * * @returns A max length action. */ declare function maxLength> | undefined>(requirement: TRequirement, message: TMessage): MaxLengthAction; //#endregion //#region src/actions/maxSize/maxSize.d.ts /** * Max size issue interface. */ interface MaxSizeIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "max_size"; /** * The expected property. */ readonly expected: `<=${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The maximum size. */ readonly requirement: TRequirement; } /** * Max size action interface. */ interface MaxSizeAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "max_size"; /** * The action reference. */ readonly reference: typeof maxSize; /** * The expected property. */ readonly expects: `<=${TRequirement}`; /** * The maximum size. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a max size validation action. * * @param requirement The maximum size. * * @returns A max size action. */ declare function maxSize(requirement: TRequirement): MaxSizeAction; /** * Creates a max size validation action. * * @param requirement The maximum size. * @param message The error message. * * @returns A max size action. */ declare function maxSize> | undefined>(requirement: TRequirement, message: TMessage): MaxSizeAction; //#endregion //#region src/actions/maxValue/maxValue.d.ts /** * Max value issue interface. */ interface MaxValueIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "max_value"; /** * The expected property. */ readonly expected: `<=${string}`; /** * The maximum value. */ readonly requirement: TRequirement; } /** * Max value action interface. */ interface MaxValueAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "max_value"; /** * The action reference. */ readonly reference: typeof maxValue; /** * The expected property. */ readonly expects: `<=${string}`; /** * The maximum value. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a max value validation action. * * @param requirement The maximum value. * * @returns A max value action. */ declare function maxValue(requirement: TRequirement): MaxValueAction; /** * Creates a max value validation action. * * @param requirement The maximum value. * @param message The error message. * * @returns A max value action. */ declare function maxValue> | undefined>(requirement: TRequirement, message: TMessage): MaxValueAction; //#endregion //#region src/actions/maxWords/maxWords.d.ts /** * Max words issue interface. */ interface MaxWordsIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "max_words"; /** * The expected property. */ readonly expected: `<=${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The maximum words. */ readonly requirement: TRequirement; } /** * Max words action interface. */ interface MaxWordsAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "max_words"; /** * The action reference. */ readonly reference: typeof maxWords; /** * The expected property. */ readonly expects: `<=${TRequirement}`; /** * The locales to be used. */ readonly locales: TLocales; /** * The maximum words. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a max words validation action. * * @param locales The locales to be used. * @param requirement The maximum words. * * @returns A max words action. */ declare function maxWords(locales: TLocales, requirement: TRequirement): MaxWordsAction; /** * Creates a max words validation action. * * @param locales The locales to be used. * @param requirement The maximum words. * @param message The error message. * * @returns A max words action. */ declare function maxWords> | undefined>(locales: TLocales, requirement: TRequirement, message: TMessage): MaxWordsAction; //#endregion //#region src/actions/metadata/metadata.d.ts /** * Metadata action interface. */ interface MetadataAction> extends BaseMetadata { /** * The action type. */ readonly type: "metadata"; /** * The action reference. */ readonly reference: typeof metadata; /** * The metadata object. */ readonly metadata: TMetadata; } /** * Creates a custom metadata action. * * @param metadata_ The metadata object. * * @returns A metadata action. */ declare function metadata>(metadata_: TMetadata): MetadataAction; //#endregion //#region src/actions/mimeType/mimeType.d.ts /** * Requirement type. */ type Requirement = readonly `${string}/${string}`[]; /** * MIME type issue interface. */ interface MimeTypeIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "mime_type"; /** * The expected input. */ readonly expected: string; /** * The received input. */ readonly received: `"${string}"`; /** * The MIME types. */ readonly requirement: TRequirement; } /** * MIME type action interface. */ interface MimeTypeAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "mime_type"; /** * The action reference. */ readonly reference: typeof mimeType; /** * The expected property. */ readonly expects: string; /** * The MIME types. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a [MIME type](https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/MIME_types) validation action. * * @param requirement The MIME types. * * @returns A MIME type action. */ declare function mimeType(requirement: TRequirement): MimeTypeAction; /** * Creates a [MIME type](https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/MIME_types) validation action. * * @param requirement The MIME types. * @param message The error message. * * @returns A MIME type action. */ declare function mimeType> | undefined>(requirement: TRequirement, message: TMessage): MimeTypeAction; //#endregion //#region src/actions/minBytes/minBytes.d.ts /** * Min bytes issue interface. */ interface MinBytesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "min_bytes"; /** * The expected property. */ readonly expected: `>=${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The minimum bytes. */ readonly requirement: TRequirement; } /** * Min bytes action interface. */ interface MinBytesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "min_bytes"; /** * The action reference. */ readonly reference: typeof minBytes; /** * The expected property. */ readonly expects: `>=${TRequirement}`; /** * The minimum bytes. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a min [bytes](https://en.wikipedia.org/wiki/Byte) validation action. * * @param requirement The minimum bytes. * * @returns A min bytes action. */ declare function minBytes(requirement: TRequirement): MinBytesAction; /** * Creates a min [bytes](https://en.wikipedia.org/wiki/Byte) validation action. * * @param requirement The minimum bytes. * @param message The error message. * * @returns A min bytes action. */ declare function minBytes> | undefined>(requirement: TRequirement, message: TMessage): MinBytesAction; //#endregion //#region src/actions/minEntries/minEntries.d.ts /** * Min entries issue interface. * * @beta */ interface MinEntriesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "min_entries"; /** * The expected property. */ readonly expected: `>=${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The minimum entries. */ readonly requirement: TRequirement; } /** * Min entries action interface. * * @beta */ interface MinEntriesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "min_entries"; /** * The action reference. */ readonly reference: typeof minEntries; /** * The expected property. */ readonly expects: `>=${TRequirement}`; /** * The minimum entries. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a min entries validation action. * * @param requirement The minimum entries. * * @returns A min entries action. * * @beta */ declare function minEntries(requirement: TRequirement): MinEntriesAction; /** * Creates a min entries validation action. * * @param requirement The minimum entries. * @param message The error message. * * @returns A min entries action. * * @beta */ declare function minEntries> | undefined>(requirement: TRequirement, message: TMessage): MinEntriesAction; //#endregion //#region src/actions/minGraphemes/minGraphemes.d.ts /** * Min graphemes issue interface. */ interface MinGraphemesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "min_graphemes"; /** * The expected property. */ readonly expected: `>=${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The minimum graphemes. */ readonly requirement: TRequirement; } /** * Min graphemes action interface. */ interface MinGraphemesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "min_graphemes"; /** * The action reference. */ readonly reference: typeof minGraphemes; /** * The expected property. */ readonly expects: `>=${TRequirement}`; /** * The minimum graphemes. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a min graphemes validation action. * * @param requirement The minimum graphemes. * * @returns A min graphemes action. */ declare function minGraphemes(requirement: TRequirement): MinGraphemesAction; /** * Creates a min graphemes validation action. * * @param requirement The minimum graphemes. * @param message The error message. * * @returns A min graphemes action. */ declare function minGraphemes> | undefined>(requirement: TRequirement, message: TMessage): MinGraphemesAction; //#endregion //#region src/actions/minLength/minLength.d.ts /** * Min length issue interface. */ interface MinLengthIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "min_length"; /** * The expected property. */ readonly expected: `>=${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The minimum length. */ readonly requirement: TRequirement; } /** * Min length action interface. */ interface MinLengthAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "min_length"; /** * The action reference. */ readonly reference: typeof minLength; /** * The expected property. */ readonly expects: `>=${TRequirement}`; /** * The minimum length. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a min length validation action. * * @param requirement The minimum length. * * @returns A min length action. */ declare function minLength(requirement: TRequirement): MinLengthAction; /** * Creates a min length validation action. * * @param requirement The minimum length. * @param message The error message. * * @returns A min length action. */ declare function minLength> | undefined>(requirement: TRequirement, message: TMessage): MinLengthAction; //#endregion //#region src/actions/minSize/minSize.d.ts /** * Min size issue interface. */ interface MinSizeIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "min_size"; /** * The expected property. */ readonly expected: `>=${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The minimum size. */ readonly requirement: TRequirement; } /** * Min size action interface. */ interface MinSizeAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "min_size"; /** * The action reference. */ readonly reference: typeof minSize; /** * The expected property. */ readonly expects: `>=${TRequirement}`; /** * The minimum size. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a min size validation action. * * @param requirement The minimum size. * * @returns A min size action. */ declare function minSize(requirement: TRequirement): MinSizeAction; /** * Creates a min size validation action. * * @param requirement The minimum size. * @param message The error message. * * @returns A min size action. */ declare function minSize> | undefined>(requirement: TRequirement, message: TMessage): MinSizeAction; //#endregion //#region src/actions/minValue/minValue.d.ts /** * Min value issue interface. */ interface MinValueIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "min_value"; /** * The expected property. */ readonly expected: `>=${string}`; /** * The minimum value. */ readonly requirement: TRequirement; } /** * Min value action interface. */ interface MinValueAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "min_value"; /** * The action reference. */ readonly reference: typeof minValue; /** * The expected property. */ readonly expects: `>=${string}`; /** * The minimum value. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a min value validation action. * * @param requirement The minimum value. * * @returns A min value action. */ declare function minValue(requirement: TRequirement): MinValueAction; /** * Creates a min value validation action. * * @param requirement The minimum value. * @param message The error message. * * @returns A min value action. */ declare function minValue> | undefined>(requirement: TRequirement, message: TMessage): MinValueAction; //#endregion //#region src/actions/minWords/minWords.d.ts /** * Min words issue interface. */ interface MinWordsIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "min_words"; /** * The expected property. */ readonly expected: `>=${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The minimum words. */ readonly requirement: TRequirement; } /** * Min words action interface. */ interface MinWordsAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "min_words"; /** * The action reference. */ readonly reference: typeof minWords; /** * The expected property. */ readonly expects: `>=${TRequirement}`; /** * The locales to be used. */ readonly locales: TLocales; /** * The minimum words. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a min words validation action. * * @param locales The locales to be used. * @param requirement The minimum words. * * @returns A min words action. */ declare function minWords(locales: TLocales, requirement: TRequirement): MinWordsAction; /** * Creates a min words validation action. * * @param locales The locales to be used. * @param requirement The minimum words. * @param message The error message. * * @returns A min words action. */ declare function minWords> | undefined>(locales: TLocales, requirement: TRequirement, message: TMessage): MinWordsAction; //#endregion //#region src/actions/multipleOf/multipleOf.d.ts /** * Input type */ type Input = number | bigint; /** * Multiple of issue interface. */ interface MultipleOfIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "multiple_of"; /** * The expected property. */ readonly expected: `%${TRequirement}`; /** * The received property. */ readonly received: `${TInput$1}`; /** * The divisor. */ readonly requirement: TRequirement; } /** * Multiple of action interface. */ interface MultipleOfAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "multiple_of"; /** * The action reference. */ readonly reference: typeof multipleOf; /** * The expected property. */ readonly expects: `%${TRequirement}`; /** * The divisor. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a [multiple](https://en.wikipedia.org/wiki/Multiple_(mathematics)) of validation action. * * @param requirement The divisor. * * @returns A multiple of action. */ declare function multipleOf(requirement: TRequirement): MultipleOfAction; /** * Creates a [multiple](https://en.wikipedia.org/wiki/Multiple_(mathematics)) of validation action. * * @param requirement The divisor. * * @returns A multiple of action. */ declare function multipleOf(requirement: TRequirement): MultipleOfAction; /** * Creates a [multiple](https://en.wikipedia.org/wiki/Multiple_(mathematics)) of validation action. * * @param requirement The divisor. * @param message The error message. * * @returns A multiple of action. */ declare function multipleOf> | undefined>(requirement: TRequirement, message: TMessage): MultipleOfAction; /** * Creates a [multiple](https://en.wikipedia.org/wiki/Multiple_(mathematics)) of validation action. * * @param requirement The divisor. * @param message The error message. * * @returns A multiple of action. */ declare function multipleOf> | undefined>(requirement: TRequirement, message: TMessage): MultipleOfAction; //#endregion //#region src/actions/nanoid/nanoid.d.ts /** * Nano ID issue interface. */ interface NanoIdIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "nanoid"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: string; /** * The Nano ID regex. */ readonly requirement: RegExp; } /** * Nano ID issue type. * * @deprecated Use `NanoIdIssue` instead. */ type NanoIDIssue = NanoIdIssue; /** * Nano ID action interface. */ interface NanoIdAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "nanoid"; /** * The action reference. */ readonly reference: typeof nanoid; /** * The expected property. */ readonly expects: null; /** * The Nano ID regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Nano ID action type. * * @deprecated Use `NanoIdAction` instead. */ type NanoIDAction> | undefined> = NanoIdAction; /** * Creates a [Nano ID](https://github.com/ai/nanoid) validation action. * * @returns A Nano ID action. */ declare function nanoid(): NanoIdAction; /** * Creates a [Nano ID](https://github.com/ai/nanoid) validation action. * * @param message The error message. * * @returns A Nano ID action. */ declare function nanoid> | undefined>(message: TMessage): NanoIdAction; //#endregion //#region src/actions/nonEmpty/nonEmpty.d.ts /** * Non empty issue interface. */ interface NonEmptyIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "non_empty"; /** * The expected input. */ readonly expected: "!0"; /** * The received input. */ readonly received: "0"; } /** * Non empty action interface. */ interface NonEmptyAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "non_empty"; /** * The action reference. */ readonly reference: typeof nonEmpty; /** * The expected property. */ readonly expects: "!0"; /** * The error message. */ readonly message: TMessage; } /** * Creates a non-empty validation action. * * @returns A non-empty action. */ declare function nonEmpty(): NonEmptyAction; /** * Creates a non-empty validation action. * * @param message The error message. * * @returns A non-empty action. */ declare function nonEmpty> | undefined>(message: TMessage): NonEmptyAction; //#endregion //#region src/actions/normalize/normalize.d.ts /** * Normalize form type. */ type NormalizeForm = "NFC" | "NFD" | "NFKC" | "NFKD"; /** * Normalize action interface. */ interface NormalizeAction extends BaseTransformation { /** * The action type. */ readonly type: "normalize"; /** * The action reference. */ readonly reference: typeof normalize; /** * The normalization form. */ readonly form: TForm; } /** * Creates a normalize transformation action. * * @returns A normalize action. */ declare function normalize(): NormalizeAction; /** * Creates a normalize transformation action. * * @param form The normalization form. * * @returns A normalize action. */ declare function normalize(form: TForm): NormalizeAction; //#endregion //#region src/actions/notBytes/notBytes.d.ts /** * Not bytes issue interface. */ interface NotBytesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "not_bytes"; /** * The expected property. */ readonly expected: `!${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The not required bytes. */ readonly requirement: TRequirement; } /** * Not bytes action interface. */ interface NotBytesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "not_bytes"; /** * The action reference. */ readonly reference: typeof notBytes; /** * The expected property. */ readonly expects: `!${TRequirement}`; /** * The not required bytes. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a not [bytes](https://en.wikipedia.org/wiki/Byte) validation action. * * @param requirement The not required bytes. * * @returns A not bytes action. */ declare function notBytes(requirement: TRequirement): NotBytesAction; /** * Creates a not [bytes](https://en.wikipedia.org/wiki/Byte) validation action. * * @param requirement The not required bytes. * @param message The error message. * * @returns A not bytes action. */ declare function notBytes> | undefined>(requirement: TRequirement, message: TMessage): NotBytesAction; //#endregion //#region src/actions/notEntries/notEntries.d.ts /** * Not entries issue interface. * * @beta */ interface NotEntriesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "not_entries"; /** * The expected property. */ readonly expected: `!${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The not required entries. */ readonly requirement: TRequirement; } /** * Not entries action interface. * * @beta */ interface NotEntriesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "not_entries"; /** * The action reference. */ readonly reference: typeof notEntries; /** * The expected property. */ readonly expects: `!${TRequirement}`; /** * The not required entries. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a not entries validation action. * * @param requirement The not required entries. * * @returns A not entries action. * * @beta */ declare function notEntries(requirement: TRequirement): NotEntriesAction; /** * Creates a not entries validation action. * * @param requirement The not required entries. * @param message The error message. * * @returns A not entries action. * * @beta */ declare function notEntries> | undefined>(requirement: TRequirement, message: TMessage): NotEntriesAction; //#endregion //#region src/actions/notGraphemes/notGraphemes.d.ts /** * Not graphemes issue interface. */ interface NotGraphemesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "not_graphemes"; /** * The expected property. */ readonly expected: `!${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The not required graphemes. */ readonly requirement: TRequirement; } /** * Not graphemes action interface. */ interface NotGraphemesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "not_graphemes"; /** * The action reference. */ readonly reference: typeof notGraphemes; /** * The expected property. */ readonly expects: `!${TRequirement}`; /** * The not required graphemes. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a not graphemes validation action. * * @param requirement The not required graphemes. * * @returns A not graphemes action. */ declare function notGraphemes(requirement: TRequirement): NotGraphemesAction; /** * Creates a not graphemes validation action. * * @param requirement The not required graphemes. * @param message The error message. * * @returns A not graphemes action. */ declare function notGraphemes> | undefined>(requirement: TRequirement, message: TMessage): NotGraphemesAction; //#endregion //#region src/actions/notLength/notLength.d.ts /** * Not length issue interface. */ interface NotLengthIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "not_length"; /** * The expected property. */ readonly expected: `!${TRequirement}`; /** * The received property. */ readonly received: `${TRequirement}`; /** * The not required length. */ readonly requirement: TRequirement; } /** * Not length action interface. */ interface NotLengthAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "not_length"; /** * The action reference. */ readonly reference: typeof notLength; /** * The expected property. */ readonly expects: `!${TRequirement}`; /** * The not required length. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a not length validation action. * * @param requirement The not required length. * * @returns A not length action. */ declare function notLength(requirement: TRequirement): NotLengthAction; /** * Creates a not length validation action. * * @param requirement The not required length. * @param message The error message. * * @returns A not length action. */ declare function notLength> | undefined>(requirement: TRequirement, message: TMessage): NotLengthAction; //#endregion //#region src/actions/notSize/notSize.d.ts /** * Not size issue interface. */ interface NotSizeIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "not_size"; /** * The expected property. */ readonly expected: `!${TRequirement}`; /** * The received property. */ readonly received: `${TRequirement}`; /** * The not required size. */ readonly requirement: TRequirement; } /** * Not size action interface. */ interface NotSizeAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "not_size"; /** * The action reference. */ readonly reference: typeof notSize; /** * The expected property. */ readonly expects: `!${TRequirement}`; /** * The not required size. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a not size validation action. * * @param requirement The not required size. * * @returns A not size action. */ declare function notSize(requirement: TRequirement): NotSizeAction; /** * Creates a not size validation action. * * @param requirement The not required size. * @param message The error message. * * @returns A not size action. */ declare function notSize> | undefined>(requirement: TRequirement, message: TMessage): NotSizeAction; //#endregion //#region src/actions/notValue/notValue.d.ts /** * Not value issue interface. */ interface NotValueIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "not_value"; /** * The expected property. */ readonly expected: `!${string}`; /** * The not required value. */ readonly requirement: TRequirement; } /** * Not value action interface. */ interface NotValueAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "not_value"; /** * The action reference. */ readonly reference: typeof notValue; /** * The expected property. */ readonly expects: `!${string}`; /** * The not required value. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a not value validation action. * * @param requirement The not required value. * * @returns A not value action. */ declare function notValue(requirement: TRequirement): NotValueAction; /** * Creates a not value validation action. * * @param requirement The not required value. * @param message The error message. * * @returns A not value action. */ declare function notValue> | undefined>(requirement: TRequirement, message: TMessage): NotValueAction; //#endregion //#region src/actions/notValues/notValues.d.ts /** * Not values issue type. */ interface NotValuesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "not_values"; /** * The expected property. */ readonly expected: `!${string}`; /** * The not required values. */ readonly requirement: TRequirement; } /** * Not values action type. */ interface NotValuesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "not_values"; /** * The action reference. */ readonly reference: typeof notValues; /** * The expected property. */ readonly expects: `!${string}`; /** * The not required values. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a not values validation action. * * @param requirement The not required values. * * @returns A not values action. */ declare function notValues(requirement: TRequirement): NotValuesAction; /** * Creates a not values validation action. * * @param requirement The not required values. * @param message The error message. * * @returns A not values action. */ declare function notValues> | undefined>(requirement: TRequirement, message: TMessage): NotValuesAction; //#endregion //#region src/actions/notWords/notWords.d.ts /** * Not words issue interface. */ interface NotWordsIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "not_words"; /** * The expected property. */ readonly expected: `!${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The not required words. */ readonly requirement: TRequirement; } /** * Not words action interface. */ interface NotWordsAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "not_words"; /** * The action reference. */ readonly reference: typeof notWords; /** * The expected property. */ readonly expects: `!${TRequirement}`; /** * The locales to be used. */ readonly locales: TLocales; /** * The not required words. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a not words validation action. * * @param locales The locales to be used. * @param requirement The not required words. * * @returns A not words action. */ declare function notWords(locales: TLocales, requirement: TRequirement): NotWordsAction; /** * Creates a not words validation action. * * @param locales The locales to be used. * @param requirement The not required words. * @param message The error message. * * @returns A not words action. */ declare function notWords> | undefined>(locales: TLocales, requirement: TRequirement, message: TMessage): NotWordsAction; //#endregion //#region src/actions/octal/octal.d.ts /** * Octal issue interface. */ interface OctalIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "octal"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The octal regex. */ readonly requirement: RegExp; } /** * Octal action interface. */ interface OctalAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "octal"; /** * The action reference. */ readonly reference: typeof octal; /** * The expected property. */ readonly expects: null; /** * The octal regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [octal](https://en.wikipedia.org/wiki/Octal) validation action. * * @returns An octal action. */ declare function octal(): OctalAction; /** * Creates an [octal](https://en.wikipedia.org/wiki/Octal) validation action. * * @param message The error message. * * @returns An octal action. */ declare function octal> | undefined>(message: TMessage): OctalAction; //#endregion //#region src/actions/parseJson/parseJson.d.ts /** * Parse JSON config interface. * * @beta */ interface ParseJsonConfig { /** * The JSON reviver function. */ reviver?: (this: any, key: string, value: any) => any; } /** * Parse JSON issue interface. * * @beta */ interface ParseJsonIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "transformation"; /** * The issue type. */ readonly type: "parse_json"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; } /** * Parse JSON action interface. * * @beta */ interface ParseJsonAction> | undefined> extends BaseTransformation> { /** * The action type. */ readonly type: "parse_json"; /** * The action reference. */ readonly reference: typeof parseJson; /** * The action config. */ readonly config: TConfig; /** * The error message. */ readonly message: TMessage; } /** * Creates a parse JSON transformation action. * * @returns A parse JSON action. * * @beta */ declare function parseJson(): ParseJsonAction; /** * Creates a parse JSON transformation action. * * @param config The action config. * * @returns A parse JSON action. * * @beta */ declare function parseJson(config: TConfig): ParseJsonAction; /** * Creates a parse JSON transformation action. * * @param config The action config. * @param message The error message. * * @returns A parse JSON action. * * @beta */ declare function parseJson> | undefined>(config: TConfig, message: TMessage): ParseJsonAction; //#endregion //#region src/actions/partialCheck/types.d.ts /** * Partial input type. */ type PartialInput = Record | ArrayLike; /** * Partial check issue interface. */ interface PartialCheckIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "partial_check"; /** * The expected input. */ readonly expected: null; /** * The validation function. */ readonly requirement: (input: TInput$1) => MaybePromise; } /** * Extracts the exact keys of a tuple, array or object. */ type KeyOf = IsAny extends true ? never : TValue$1 extends readonly unknown[] ? number extends TValue$1["length"] ? "$" : { [TKey in keyof TValue$1]: TKey extends `${infer TIndex extends number}` ? TIndex : never }[number] : TValue$1 extends Record ? keyof TValue$1 & (string | number) : never; /** * Path type. */ type Path = readonly (string | number)[]; /** * Required path type. */ type RequiredPath = readonly [string | number, ...Path]; /** * Paths type. */ type Paths = readonly RequiredPath[]; /** * Required paths type. */ type RequiredPaths = readonly [RequiredPath, ...RequiredPath[]]; /** * Lazily evaluate only the first valid path segment based on the given value. */ type LazyPath = TPathToCheck extends readonly [] ? TValidPath : TPathToCheck extends readonly [infer TFirstKey extends KeyOf, ...infer TPathRest extends Path] ? LazyPath : IsNever> extends false ? readonly [...TValidPath, KeyOf] : TValidPath; /** * Returns the path if valid, otherwise the first possible valid path based on * the given value. */ type ValidPath = TPath extends LazyPath ? TPath : LazyPath; /** * Returns a valid path for any given path based on the given value. */ type ValidPaths = { [TKey in keyof TPaths]: ValidPath }; /** * Deeply picks specific keys. * * Hint: If this type is ever exported and accessible from the outside, it must * be wrapped in `UnionToIntersect` to avoid invalid results. */ type DeepPick = TPath extends readonly [infer TFirstKey extends string | number, ...infer TPathRest extends Path] ? TValue$1 extends readonly unknown[] ? number extends TValue$1["length"] ? TPathRest extends readonly [] ? TValue$1 : DeepPick[] : { [TKey in keyof TValue$1]: TKey extends `${TFirstKey}` ? TPathRest extends readonly [] ? TValue$1[TKey] : DeepPick : unknown } : { [TKey in keyof TValue$1 as TKey extends TFirstKey ? TKey : never]: TPathRest extends readonly [] ? TValue$1[TKey] : DeepPick } : never; /** * Deeply merges two types. */ type DeepMerge = TValue1 extends readonly unknown[] ? TValue2 extends readonly unknown[] ? number extends TValue1["length"] | TValue2["length"] ? DeepMerge[] : { [TKey in keyof TValue1]: TKey extends keyof TValue2 ? unknown extends TValue1[TKey] ? TValue2[TKey] : TValue1[TKey] : never } : never : TValue1 extends Record ? TValue2 extends Record ? { [TKey in keyof (TValue1 & TValue2)]: TKey extends keyof TValue1 ? TKey extends keyof TValue2 ? DeepMerge : TValue1[TKey] : TKey extends keyof TValue2 ? TValue2[TKey] : never } : never : TValue1 & TValue2; /** * Deeply picks N specific keys. */ type DeepPickN = TPaths extends readonly [infer TFirstPath extends Path, ...infer TRestPaths extends Paths] ? TRestPaths extends readonly [] ? DeepPick : DeepMerge, DeepPickN> : TInput$1; //#endregion //#region src/actions/partialCheck/partialCheck.d.ts /** * Partial check action interface. */ interface PartialCheckAction, TMessage extends ErrorMessage> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "partial_check"; /** * The action reference. */ readonly reference: typeof partialCheck; /** * The expected property. */ readonly expects: null; /** * The selected paths. */ readonly paths: TPaths; /** * The validation function. */ readonly requirement: (input: TSelection) => boolean; /** * The error message. */ readonly message: TMessage; } /** * Creates a partial check validation action. * * @param paths The selected paths. * @param requirement The validation function. * * @returns A partial check action. */ declare function partialCheck>(paths: ValidPaths, requirement: (input: TSelection) => boolean): PartialCheckAction; /** * Creates a partial check validation action. * * @param paths The selected paths. * @param requirement The validation function. * @param message The error message. * * @returns A partial check action. */ declare function partialCheck, const TMessage extends ErrorMessage> | undefined>(paths: ValidPaths, requirement: (input: TSelection) => boolean, message: TMessage): PartialCheckAction; //#endregion //#region src/actions/partialCheck/partialCheckAsync.d.ts /** * Partial check action async interface. */ interface PartialCheckActionAsync, TMessage extends ErrorMessage> | undefined> extends BaseValidationAsync> { /** * The action type. */ readonly type: "partial_check"; /** * The action reference. */ readonly reference: typeof partialCheckAsync; /** * The expected property. */ readonly expects: null; /** * The selected paths. */ readonly paths: TPaths; /** * The validation function. */ readonly requirement: (input: TSelection) => MaybePromise; /** * The error message. */ readonly message: TMessage; } /** * Creates a partial check validation action. * * @param paths The selected paths. * @param requirement The validation function. * * @returns A partial check action. */ declare function partialCheckAsync>(paths: ValidPaths, requirement: (input: TSelection) => MaybePromise): PartialCheckActionAsync; /** * Creates a partial check validation action. * * @param paths The selected paths. * @param requirement The validation function. * @param message The error message. * * @returns A partial check action. */ declare function partialCheckAsync, const TMessage extends ErrorMessage> | undefined>(paths: ValidPaths, requirement: (input: TSelection) => MaybePromise, message: TMessage): PartialCheckActionAsync; //#endregion //#region src/actions/rawCheck/types.d.ts /** * Raw check issue interface. */ interface RawCheckIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "raw_check"; } /** * Raw check issue info interface. */ interface RawCheckIssueInfo { label?: string | undefined; input?: unknown | undefined; expected?: string | undefined; received?: string | undefined; message?: ErrorMessage> | undefined; path?: [IssuePathItem, ...IssuePathItem[]] | undefined; } /** * Raw check add issue type. */ type RawCheckAddIssue = (info?: RawCheckIssueInfo) => void; /** * Raw check context interface. */ interface RawCheckContext { readonly dataset: OutputDataset>; readonly config: Config>; readonly addIssue: RawCheckAddIssue; } //#endregion //#region src/actions/rawCheck/rawCheck.d.ts /** * Raw check action interface. */ interface RawCheckAction extends BaseValidation> { /** * The action type. */ readonly type: "raw_check"; /** * The action reference. */ readonly reference: typeof rawCheck; /** * The expected property. */ readonly expects: null; } /** * Creates a raw check validation action. * * @param action The validation action. * * @returns A raw check action. */ declare function rawCheck(action: (context: RawCheckContext) => void): RawCheckAction; //#endregion //#region src/actions/rawCheck/rawCheckAsync.d.ts /** * Raw check action async interface. */ interface RawCheckActionAsync extends BaseValidationAsync> { /** * The action type. */ readonly type: "raw_check"; /** * The action reference. */ readonly reference: typeof rawCheckAsync; /** * The expected property. */ readonly expects: null; } /** * Creates a raw check validation action. * * @param action The validation action. * * @returns A raw check action. */ declare function rawCheckAsync(action: (context: RawCheckContext) => MaybePromise): RawCheckActionAsync; //#endregion //#region src/actions/rawTransform/types.d.ts /** * Raw transform issue interface. */ interface RawTransformIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "transformation"; /** * The issue type. */ readonly type: "raw_transform"; } /** * Raw transform issue info interface. */ interface RawTransformIssueInfo { label?: string | undefined; input?: unknown | undefined; expected?: string | undefined; received?: string | undefined; message?: ErrorMessage> | undefined; path?: [IssuePathItem, ...IssuePathItem[]] | undefined; } /** * Raw transform add issue type. */ type RawTransformAddIssue = (info?: RawTransformIssueInfo) => void; /** * Raw transform context interface. */ interface RawTransformContext { readonly dataset: SuccessDataset; readonly config: Config>; readonly addIssue: RawTransformAddIssue; readonly NEVER: never; } //#endregion //#region src/actions/rawTransform/rawTransform.d.ts /** * Raw transform action interface. */ interface RawTransformAction extends BaseTransformation> { /** * The action type. */ readonly type: "raw_transform"; /** * The action reference. */ readonly reference: typeof rawTransform; } /** * Creates a raw transformation action. * * @param action The transformation action. * * @returns A raw transform action. */ declare function rawTransform(action: (context: RawTransformContext) => TOutput$1): RawTransformAction; //#endregion //#region src/actions/rawTransform/rawTransformAsync.d.ts /** * Raw transform action async interface. */ interface RawTransformActionAsync extends BaseTransformationAsync> { /** * The action type. */ readonly type: "raw_transform"; /** * The action reference. */ readonly reference: typeof rawTransformAsync; } /** * Creates a raw transformation action. * * @param action The transformation action. * * @returns A raw transform action. */ declare function rawTransformAsync(action: (context: RawTransformContext) => MaybePromise): RawTransformActionAsync; //#endregion //#region src/actions/readonly/readonly.d.ts /** * Readonly output type. */ type ReadonlyOutput = TInput$1 extends Map ? ReadonlyMap : TInput$1 extends Set ? ReadonlySet : Readonly; /** * Readonly action interface. */ interface ReadonlyAction extends BaseTransformation, never> { /** * The action type. */ readonly type: "readonly"; /** * The action reference. */ readonly reference: typeof readonly; } /** * Creates a readonly transformation action. * * @returns A readonly action. */ declare function readonly(): ReadonlyAction; //#endregion //#region src/actions/reduceItems/reduceItems.d.ts /** * Array action type. */ type ArrayAction$1 = (output: TOutput$1, item: TInput$1[number], index: number, array: TInput$1) => TOutput$1; /** * Reduce items action interface. */ interface ReduceItemsAction extends BaseTransformation { /** * The action type. */ readonly type: "reduce_items"; /** * The action reference. */ readonly reference: typeof reduceItems; /** * The reduce items operation. */ readonly operation: ArrayAction$1; /** * The initial value. */ readonly initial: TOutput$1; } /** * Creates a reduce items transformation action. * * @param operation The reduce items operation. * @param initial The initial value. * * @returns A reduce items action. */ declare function reduceItems(operation: ArrayAction$1, initial: TOutput$1): ReduceItemsAction; //#endregion //#region src/actions/regex/regex.d.ts /** * Regex issue interface. */ interface RegexIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "regex"; /** * The expected input. */ readonly expected: string; /** * The received input. */ readonly received: `"${string}"`; /** * The regex pattern. */ readonly requirement: RegExp; } /** * Regex action interface. */ interface RegexAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "regex"; /** * The action reference. */ readonly reference: typeof regex; /** * The expected property. */ readonly expects: string; /** * The regex pattern. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a [regex](https://en.wikipedia.org/wiki/Regular_expression) validation action. * * Hint: Be careful with the global flag `g` in your regex pattern, as it can lead to unexpected results. See [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/test#using_test_on_a_regex_with_the_global_flag) for more information. * * @param requirement The regex pattern. * * @returns A regex action. */ declare function regex(requirement: RegExp): RegexAction; /** * Creates a [regex](https://en.wikipedia.org/wiki/Regular_expression) validation action. * * Hint: Be careful with the global flag `g` in your regex pattern, as it can lead to unexpected results. See [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/test#using_test_on_a_regex_with_the_global_flag) for more information. * * @param requirement The regex pattern. * @param message The error message. * * @returns A regex action. */ declare function regex> | undefined>(requirement: RegExp, message: TMessage): RegexAction; //#endregion //#region src/actions/returns/returns.d.ts /** * Returns action type. */ interface ReturnsAction unknown, TSchema extends BaseSchema>> extends BaseTransformation) => InferOutput, never> { /** * The action type. */ readonly type: "returns"; /** * The action reference. */ readonly reference: typeof returns; /** * The arguments schema. */ readonly schema: TSchema; } /** * Creates a function return transformation action. * * @param schema The arguments schema. * * @returns An returns action. */ declare function returns unknown, TSchema extends BaseSchema>>(schema: TSchema): ReturnsAction; //#endregion //#region src/actions/returns/returnsAsync.d.ts /** * Returns action async type. */ interface ReturnsActionAsync unknown, TSchema extends BaseSchema> | BaseSchemaAsync>> extends BaseTransformation) => Promise>>, never> { /** * The action type. */ readonly type: "returns"; /** * The action reference. */ readonly reference: typeof returnsAsync; /** * The arguments schema. */ readonly schema: TSchema; } /** * Creates a function arguments transformation action. * * @param schema The arguments schema. * * @returns An returns action. */ declare function returnsAsync unknown, TSchema extends BaseSchema> | BaseSchemaAsync>>(schema: TSchema): ReturnsActionAsync; //#endregion //#region src/actions/rfcEmail/rfcEmail.d.ts /** * RFC email issue interface. */ interface RfcEmailIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "rfc_email"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The RFC email regex. */ readonly requirement: RegExp; } /** * RFC email action interface. */ interface RfcEmailAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "rfc_email"; /** * The action reference. */ readonly reference: typeof rfcEmail; /** * The expected property. */ readonly expects: null; /** * The RFC email regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a [RFC email](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) * validation action. * * Hint: This validation action intentionally validates the entire RFC 5322 * specification. If you are interested in an action that only covers common * email addresses, please use the `email` action instead. * * @returns A RFC email action. */ declare function rfcEmail(): RfcEmailAction; /** * Creates a [RFC email](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) * validation action. * * Hint: This validation action intentionally validates the entire RFC 5322 * specification. If you are interested in an action that only covers common * email addresses, please use the `email` action instead. * * @param message The error message. * * @returns A RFC email action. */ declare function rfcEmail> | undefined>(message: TMessage): RfcEmailAction; //#endregion //#region src/actions/safeInteger/safeInteger.d.ts /** * Safe integer issue interface. */ interface SafeIntegerIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "safe_integer"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `${number}`; /** * The validation function. */ readonly requirement: (input: number) => boolean; } /** * Safe integer action interface. */ interface SafeIntegerAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "safe_integer"; /** * The action reference. */ readonly reference: typeof safeInteger; /** * The expected property. */ readonly expects: null; /** * The validation function. */ readonly requirement: (input: number) => boolean; /** * The error message. */ readonly message: TMessage; } /** * Creates a safe integer validation action. * * @returns A safe integer action. */ declare function safeInteger(): SafeIntegerAction; /** * Creates a safe integer validation action. * * @param message The error message. * * @returns A safe integer action. */ declare function safeInteger> | undefined>(message: TMessage): SafeIntegerAction; //#endregion //#region src/actions/size/size.d.ts /** * Size issue interface. */ interface SizeIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "size"; /** * The expected property. */ readonly expected: `${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The required size. */ readonly requirement: TRequirement; } /** * Size action interface. */ interface SizeAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "size"; /** * The action reference. */ readonly reference: typeof size; /** * The expected property. */ readonly expects: `${TRequirement}`; /** * The required size. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a size validation action. * * @param requirement The required size. * * @returns A size action. */ declare function size(requirement: TRequirement): SizeAction; /** * Creates a size validation action. * * @param requirement The required size. * @param message The error message. * * @returns A size action. */ declare function size> | undefined>(requirement: TRequirement, message: TMessage): SizeAction; //#endregion //#region src/actions/slug/slug.d.ts /** * Slug issue type. */ interface SlugIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "slug"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The slug regex. */ readonly requirement: RegExp; } /** * Slug action type. */ interface SlugAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "slug"; /** * The action reference. */ readonly reference: typeof slug; /** * The expected property. */ readonly expects: null; /** * The slug regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates a [slug](https://en.wikipedia.org/wiki/Clean_URL#Slug) validation action. * * @returns A slug action. */ declare function slug(): SlugAction; /** * Creates a [slug](https://en.wikipedia.org/wiki/Clean_URL#Slug) validation action. * * @param message The error message. * * @returns A slug action. */ declare function slug> | undefined>(message: TMessage): SlugAction; //#endregion //#region src/actions/someItem/someItem.d.ts /** * Some item issue interface. */ interface SomeItemIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "some_item"; /** * The expected property. */ readonly expected: null; /** * The validation function. */ readonly requirement: ArrayRequirement; } /** * Some item action interface. */ interface SomeItemAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "some_item"; /** * The action reference. */ readonly reference: typeof someItem; /** * The expected property. */ readonly expects: null; /** * The validation function. */ readonly requirement: ArrayRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a some item validation action. * * @param requirement The validation function. * * @returns A some item action. */ declare function someItem(requirement: ArrayRequirement): SomeItemAction; /** * Creates a some item validation action. * * @param requirement The validation function. * @param message The error message. * * @returns A some item action. */ declare function someItem> | undefined>(requirement: ArrayRequirement, message: TMessage): SomeItemAction; //#endregion //#region src/actions/sortItems/sortItems.d.ts /** * Array action type. */ type ArrayAction = (itemA: TInput$1[number], itemB: TInput$1[number]) => number; /** * Sort items action interface. */ interface SortItemsAction extends BaseTransformation { /** * The action type. */ readonly type: "sort_items"; /** * The action reference. */ readonly reference: typeof sortItems; /** * The sort items operation. */ readonly operation: ArrayAction | undefined; } /** * Creates a sort items transformation action. * * @param operation The sort items operation. * * @returns A sort items action. */ declare function sortItems(operation?: ArrayAction): SortItemsAction; //#endregion //#region src/actions/startsWith/startsWith.d.ts /** * Starts with issue interface. */ interface StartsWithIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "starts_with"; /** * The expected property. */ readonly expected: `"${TRequirement}"`; /** * The received property. */ readonly received: `"${string}"`; /** * The start string. */ readonly requirement: TRequirement; } /** * Starts with action interface. */ interface StartsWithAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "starts_with"; /** * The action reference. */ readonly reference: typeof startsWith; /** * The expected property. */ readonly expects: `"${TRequirement}"`; /** * The start string. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a starts with validation action. * * @param requirement The start string. * * @returns A starts with action. */ declare function startsWith(requirement: TRequirement): StartsWithAction; /** * Creates a starts with validation action. * * @param requirement The start string. * @param message The error message. * * @returns A starts with action. */ declare function startsWith> | undefined>(requirement: TRequirement, message: TMessage): StartsWithAction; //#endregion //#region src/actions/stringifyJson/stringifyJson.d.ts /** * Stringify JSON config interface. * * @beta */ interface StringifyJsonConfig { /** * The JSON replacer function or array. */ replacer?: ((this: any, key: string, value: any) => any) | (number | string)[]; /** * The JSON space option. */ space?: string | number; } /** * Stringify JSON issue interface. * * @beta */ interface StringifyJsonIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "transformation"; /** * The issue type. */ readonly type: "stringify_json"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; } /** * Stringify JSON action interface. * * @beta */ interface StringifyJsonAction> | undefined> extends BaseTransformation> { /** * The action type. */ readonly type: "stringify_json"; /** * The action reference. */ readonly reference: typeof stringifyJson; /** * The action config. */ readonly config: TConfig; /** * The error message. */ readonly message: TMessage; } /** * Creates a stringify JSON transformation action. * * @returns A stringify JSON action. * * @beta */ declare function stringifyJson(): StringifyJsonAction; /** * Creates a stringify JSON transformation action. * * @param config The action config. * * @returns A stringify JSON action. * * @beta */ declare function stringifyJson(config: TConfig): StringifyJsonAction; /** * Creates a stringify JSON transformation action. * * @param config The action config. * @param message The error message. * * @returns A stringify JSON action. * * @beta */ declare function stringifyJson> | undefined>(config: TConfig, message: TMessage): StringifyJsonAction; //#endregion //#region src/actions/toBigint/toBigint.d.ts /** * To bigint issue interface. */ interface ToBigintIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "transformation"; /** * The issue type. */ readonly type: "to_bigint"; /** * The expected property. */ readonly expected: null; } /** * To bigint action interface. */ interface ToBigintAction> | undefined> extends BaseTransformation> { /** * The action type. */ readonly type: "to_bigint"; /** * The action reference. */ readonly reference: typeof toBigint; /** * The error message. */ readonly message: TMessage; } /** * Creates a to bigint transformation action. * * @returns A to bigint action. * * @beta */ declare function toBigint(): ToBigintAction; /** * Creates a to bigint transformation action. * * @param message The error message. * * @returns A to bigint action. * * @beta */ declare function toBigint> | undefined>(message: TMessage): ToBigintAction; //#endregion //#region src/actions/toBoolean/toBoolean.d.ts /** * To boolean action interface. */ interface ToBooleanAction extends BaseTransformation { /** * The action type. */ readonly type: "to_boolean"; /** * The action reference. */ readonly reference: typeof toBoolean; } /** * Creates a to boolean transformation action. * * @returns A to boolean action. * * @beta */ declare function toBoolean(): ToBooleanAction; //#endregion //#region src/actions/toDate/toDate.d.ts /** * To date issue interface. */ interface ToDateIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "transformation"; /** * The issue type. */ readonly type: "to_date"; /** * The expected property. */ readonly expected: null; } /** * To date action interface. */ interface ToDateAction> | undefined> extends BaseTransformation> { /** * The action type. */ readonly type: "to_date"; /** * The action reference. */ readonly reference: typeof toDate; /** * The error message. */ readonly message: TMessage; } /** * Creates a to date transformation action. * * @returns A to date action. * * @beta */ declare function toDate(): ToDateAction; /** * Creates a to date transformation action. * * @param message The error message. * * @returns A to date action. * * @beta */ declare function toDate> | undefined>(message: TMessage): ToDateAction; //#endregion //#region src/actions/toLowerCase/toLowerCase.d.ts /** * To lower case action interface. */ interface ToLowerCaseAction extends BaseTransformation { /** * The action type. */ readonly type: "to_lower_case"; /** * The action reference. */ readonly reference: typeof toLowerCase; } /** * Creates a to lower case transformation action. * * @returns A to lower case action. */ declare function toLowerCase(): ToLowerCaseAction; //#endregion //#region src/actions/toMaxValue/toMaxValue.d.ts /** * To max value action interface. */ interface ToMaxValueAction extends BaseTransformation { /** * The action type. */ readonly type: "to_max_value"; /** * The action reference. */ readonly reference: typeof toMaxValue; /** * The maximum value. */ readonly requirement: TRequirement; } /** * Creates a to max value transformation action. * * @param requirement The maximum value. * * @returns A to max value action. */ declare function toMaxValue(requirement: TRequirement): ToMaxValueAction; //#endregion //#region src/actions/toMinValue/toMinValue.d.ts /** * To min value action interface. */ interface ToMinValueAction extends BaseTransformation { /** * The action type. */ readonly type: "to_min_value"; /** * The action reference. */ readonly reference: typeof toMinValue; /** * The minimum value. */ readonly requirement: TRequirement; } /** * Creates a to min value transformation action. * * @param requirement The minimum value. * * @returns A to min value action. */ declare function toMinValue(requirement: TRequirement): ToMinValueAction; //#endregion //#region src/actions/toNumber/toNumber.d.ts /** * To number issue interface. */ interface ToNumberIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "transformation"; /** * The issue type. */ readonly type: "to_number"; /** * The expected property. */ readonly expected: null; } /** * To number action interface. */ interface ToNumberAction> | undefined> extends BaseTransformation> { /** * The action type. */ readonly type: "to_number"; /** * The action reference. */ readonly reference: typeof toNumber; /** * The error message. */ readonly message: TMessage; } /** * Creates a to number transformation action. * * @returns A to number action. * * @beta */ declare function toNumber(): ToNumberAction; /** * Creates a to number transformation action. * * @param message The error message. * * @returns A to number action. * * @beta */ declare function toNumber> | undefined>(message: TMessage): ToNumberAction; //#endregion //#region src/actions/toString/toString.d.ts /** * To string issue interface. */ interface ToStringIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "transformation"; /** * The issue type. */ readonly type: "to_string"; /** * The expected property. */ readonly expected: null; } /** * To string action interface. */ interface ToStringAction> | undefined> extends BaseTransformation> { /** * The action type. */ readonly type: "to_string"; /** * The action reference. */ readonly reference: typeof toString; /** * The error message. */ readonly message: TMessage; } /** * Creates a to string transformation action. * * @returns A to string action. * * @beta */ declare function toString(): ToStringAction; /** * Creates a to string transformation action. * * @param message The error message. * * @returns A to string action. * * @beta */ declare function toString> | undefined>(message: TMessage): ToStringAction; //#endregion //#region src/actions/toUpperCase/toUpperCase.d.ts /** * To upper case action interface. */ interface ToUpperCaseAction extends BaseTransformation { /** * The action type. */ readonly type: "to_upper_case"; /** * The action reference. */ readonly reference: typeof toUpperCase; } /** * Creates a to upper case transformation action. * * @returns A to upper case action. */ declare function toUpperCase(): ToUpperCaseAction; //#endregion //#region src/actions/transform/transform.d.ts /** * Transform action interface. */ interface TransformAction extends BaseTransformation { /** * The action type. */ readonly type: "transform"; /** * The action reference. */ readonly reference: typeof transform; /** * The transformation operation. */ readonly operation: (input: TInput$1) => TOutput$1; } /** * Creates a custom transformation action. * * @param operation The transformation operation. * * @returns A transform action. */ declare function transform(operation: (input: TInput$1) => TOutput$1): TransformAction; //#endregion //#region src/actions/transform/transformAsync.d.ts /** * Transform action async interface. */ interface TransformActionAsync extends BaseTransformationAsync { /** * The action type. */ readonly type: "transform"; /** * The action reference. */ readonly reference: typeof transformAsync; /** * The transformation operation. */ readonly operation: (input: TInput$1) => Promise; } /** * Creates a custom transformation action. * * @param operation The transformation operation. * * @returns A transform action. */ declare function transformAsync(operation: (input: TInput$1) => Promise): TransformActionAsync; //#endregion //#region src/actions/trim/trim.d.ts /** * Trim action interface. */ interface TrimAction extends BaseTransformation { /** * The action type. */ readonly type: "trim"; /** * The action reference. */ readonly reference: typeof trim; } /** * Creates a trim transformation action. * * @returns A trim action. */ declare function trim(): TrimAction; //#endregion //#region src/actions/trimEnd/trimEnd.d.ts /** * Trim end action interface. */ interface TrimEndAction extends BaseTransformation { /** * The action type. */ readonly type: "trim_end"; /** * The action reference. */ readonly reference: typeof trimEnd; } /** * Creates a trim end transformation action. * * @returns A trim end action. */ declare function trimEnd(): TrimEndAction; //#endregion //#region src/actions/trimStart/trimStart.d.ts /** * Trim start action interface. */ interface TrimStartAction extends BaseTransformation { /** * The action type. */ readonly type: "trim_start"; /** * The action reference. */ readonly reference: typeof trimStart; } /** * Creates a trim start transformation action. * * @returns A trim start action. */ declare function trimStart(): TrimStartAction; //#endregion //#region src/actions/ulid/ulid.d.ts /** * ULID issue interface. */ interface UlidIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "ulid"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The ULID regex. */ readonly requirement: RegExp; } /** * ULID action interface. */ interface UlidAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "ulid"; /** * The action reference. */ readonly reference: typeof ulid; /** * The expected property. */ readonly expects: null; /** * The ULID regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [ULID](https://github.com/ulid/spec) validation action. * * @returns An ULID action. */ declare function ulid(): UlidAction; /** * Creates an [ULID](https://github.com/ulid/spec) validation action. * * @param message The error message. * * @returns An ULID action. */ declare function ulid> | undefined>(message: TMessage): UlidAction; //#endregion //#region src/actions/url/url.d.ts /** * URL issue interface. */ interface UrlIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "url"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The validation function. */ readonly requirement: (input: string) => boolean; } /** * URL action interface. */ interface UrlAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "url"; /** * The action reference. */ readonly reference: typeof url; /** * The expected property. */ readonly expects: null; /** * The validation function. */ readonly requirement: (input: string) => boolean; /** * The error message. */ readonly message: TMessage; } /** * Creates an [URL](https://en.wikipedia.org/wiki/URL) validation action. * * Hint: The value is passed to the URL constructor to check if it is valid. * This check is not perfect. For example, values like "abc:1234" are accepted. * * @returns An URL action. */ declare function url(): UrlAction; /** * Creates an [URL](https://en.wikipedia.org/wiki/URL) validation action. * * Hint: The value is passed to the URL constructor to check if it is valid. * This check is not perfect. For example, values like "abc:1234" are accepted. * * @param message The error message. * * @returns An URL action. */ declare function url> | undefined>(message: TMessage): UrlAction; //#endregion //#region src/actions/uuid/uuid.d.ts /** * UUID issue interface. */ interface UuidIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "uuid"; /** * The expected property. */ readonly expected: null; /** * The received property. */ readonly received: `"${string}"`; /** * The UUID regex. */ readonly requirement: RegExp; } /** * UUID action interface. */ interface UuidAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "uuid"; /** * The action reference. */ readonly reference: typeof uuid; /** * The expected property. */ readonly expects: null; /** * The UUID regex. */ readonly requirement: RegExp; /** * The error message. */ readonly message: TMessage; } /** * Creates an [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) validation action. * * @returns An UUID action. */ declare function uuid(): UuidAction; /** * Creates an [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) validation action. * * @param message The error message. * * @returns An UUID action. */ declare function uuid> | undefined>(message: TMessage): UuidAction; //#endregion //#region src/actions/value/value.d.ts /** * Value issue interface. */ interface ValueIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "value"; /** * The expected property. */ readonly expected: string; /** * The required value. */ readonly requirement: TRequirement; } /** * Value action interface. */ interface ValueAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "value"; /** * The action reference. */ readonly reference: typeof value; /** * The expected property. */ readonly expects: string; /** * The required value. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a value validation action. * * @param requirement The required value. * * @returns A value action. */ declare function value(requirement: TRequirement): ValueAction; /** * Creates a value validation action. * * @param requirement The required value. * @param message The error message. * * @returns A value action. */ declare function value> | undefined>(requirement: TRequirement, message: TMessage): ValueAction; //#endregion //#region src/actions/values/values.d.ts /** * Values issue type. */ interface ValuesIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "values"; /** * The expected property. */ readonly expected: string; /** * The required values. */ readonly requirement: TRequirement; } /** * Values action type. */ interface ValuesAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "values"; /** * The action reference. */ readonly reference: typeof values; /** * The expected property. */ readonly expects: string; /** * The required values. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a values validation action. * * @param requirement The required values. * * @returns A values action. */ declare function values(requirement: TRequirement): ValuesAction; /** * Creates a values validation action. * * @param requirement The required values. * @param message The error message. * * @returns A values action. */ declare function values> | undefined>(requirement: TRequirement, message: TMessage): ValuesAction; //#endregion //#region src/actions/words/words.d.ts /** * Words issue interface. */ interface WordsIssue extends BaseIssue { /** * The issue kind. */ readonly kind: "validation"; /** * The issue type. */ readonly type: "words"; /** * The expected property. */ readonly expected: `${TRequirement}`; /** * The received property. */ readonly received: `${number}`; /** * The required words. */ readonly requirement: TRequirement; } /** * Words action interface. */ interface WordsAction> | undefined> extends BaseValidation> { /** * The action type. */ readonly type: "words"; /** * The action reference. */ readonly reference: typeof words; /** * The expected property. */ readonly expects: `${TRequirement}`; /** * The locales to be used. */ readonly locales: TLocales; /** * The required words. */ readonly requirement: TRequirement; /** * The error message. */ readonly message: TMessage; } /** * Creates a words validation action. * * @param locales The locales to be used. * @param requirement The required words. * * @returns A words action. */ declare function words(locales: TLocales, requirement: TRequirement): WordsAction; /** * Creates a words validation action. * * @param locales The locales to be used. * @param requirement The required words. * @param message The error message. * * @returns A words action. */ declare function words> | undefined>(locales: TLocales, requirement: TRequirement, message: TMessage): WordsAction; //#endregion //#region src/regex.d.ts /** * [Base64](https://en.wikipedia.org/wiki/Base64) regex. */ declare const BASE64_REGEX: RegExp; /** * [BIC](https://en.wikipedia.org/wiki/ISO_9362) regex. */ declare const BIC_REGEX: RegExp; /** * [Cuid2](https://github.com/paralleldrive/cuid2) regex. */ declare const CUID2_REGEX: RegExp; /** * [Decimal](https://en.wikipedia.org/wiki/Decimal) regex. */ declare const DECIMAL_REGEX: RegExp; /** * [Digits](https://en.wikipedia.org/wiki/Numerical_digit) regex. */ declare const DIGITS_REGEX: RegExp; /** * [Email address](https://en.wikipedia.org/wiki/Email_address) regex. */ declare const EMAIL_REGEX: RegExp; /** * Emoji regex from [emoji-regex-xs](https://github.com/slevithan/emoji-regex-xs) v1.0.0 (MIT license). * * Hint: We decided against the newer `/^\p{RGI_Emoji}+$/v` regex because it is * not supported in older runtimes and does not match all emoji. */ declare const EMOJI_REGEX: RegExp; /** * [Hexadecimal](https://en.wikipedia.org/wiki/Hexadecimal) regex. * * Hint: We decided against the `i` flag for better JSON Schema compatibility. */ declare const HEXADECIMAL_REGEX: RegExp; /** * [Hex color](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet) regex. * * Hint: We decided against the `i` flag for better JSON Schema compatibility. */ declare const HEX_COLOR_REGEX: RegExp; /** * [IMEI](https://en.wikipedia.org/wiki/International_Mobile_Equipment_Identity) regex. */ declare const IMEI_REGEX: RegExp; /** * [IPv4](https://en.wikipedia.org/wiki/IPv4) regex. */ declare const IPV4_REGEX: RegExp; /** * [IPv6](https://en.wikipedia.org/wiki/IPv6) regex. */ declare const IPV6_REGEX: RegExp; /** * [IP](https://en.wikipedia.org/wiki/IP_address) regex. */ declare const IP_REGEX: RegExp; /** * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date regex. */ declare const ISO_DATE_REGEX: RegExp; /** * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time regex. */ declare const ISO_DATE_TIME_REGEX: RegExp; /** * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time regex. */ declare const ISO_TIME_REGEX: RegExp; /** * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time with seconds regex. */ declare const ISO_TIME_SECOND_REGEX: RegExp; /** * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp regex. */ declare const ISO_TIMESTAMP_REGEX: RegExp; /** * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) week regex. */ declare const ISO_WEEK_REGEX: RegExp; /** * [MAC](https://en.wikipedia.org/wiki/MAC_address) 48 bit regex. */ declare const MAC48_REGEX: RegExp; /** * [MAC](https://en.wikipedia.org/wiki/MAC_address) 64 bit regex. */ declare const MAC64_REGEX: RegExp; /** * [MAC](https://en.wikipedia.org/wiki/MAC_address) regex. */ declare const MAC_REGEX: RegExp; /** * [Nano ID](https://github.com/ai/nanoid) regex. */ declare const NANO_ID_REGEX: RegExp; /** * [Octal](https://en.wikipedia.org/wiki/Octal) regex. */ declare const OCTAL_REGEX: RegExp; /** * [RFC 5322 email address](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) regex. * * Hint: This regex was taken from the [HTML Living Standard Specification](https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address) and does not perfectly represent RFC 5322. */ declare const RFC_EMAIL_REGEX: RegExp; /** * [Slug](https://en.wikipedia.org/wiki/Clean_URL#Slug) regex. */ declare const SLUG_REGEX: RegExp; /** * [ULID](https://github.com/ulid/spec) regex. * * Hint: We decided against the `i` flag for better JSON Schema compatibility. */ declare const ULID_REGEX: RegExp; /** * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) regex. */ declare const UUID_REGEX: RegExp; //#endregion //#region src/storages/globalConfig/globalConfig.d.ts /** * The global config type. */ type GlobalConfig = Omit, "message">; /** * Sets the global configuration. * * @param config The configuration. */ declare function setGlobalConfig(config: GlobalConfig): void; /** * Returns the global configuration. * * @param config The config to merge. * * @returns The configuration. */ declare function getGlobalConfig>(config?: Config): Config; /** * Deletes the global configuration. */ declare function deleteGlobalConfig(): void; //#endregion //#region src/storages/globalMessage/globalMessage.d.ts /** * Sets a global error message. * * @param message The error message. * @param lang The language of the message. */ declare function setGlobalMessage(message: ErrorMessage>, lang?: string): void; /** * Returns a global error message. * * @param lang The language of the message. * * @returns The error message. */ declare function getGlobalMessage(lang?: string): ErrorMessage> | undefined; /** * Deletes a global error message. * * @param lang The language of the message. */ declare function deleteGlobalMessage(lang?: string): void; //#endregion //#region src/storages/schemaMessage/schemaMessage.d.ts /** * Sets a schema error message. * * @param message The error message. * @param lang The language of the message. */ declare function setSchemaMessage(message: ErrorMessage>, lang?: string): void; /** * Returns a schema error message. * * @param lang The language of the message. * * @returns The error message. */ declare function getSchemaMessage(lang?: string): ErrorMessage> | undefined; /** * Deletes a schema error message. * * @param lang The language of the message. */ declare function deleteSchemaMessage(lang?: string): void; //#endregion //#region src/storages/specificMessage/specificMessage.d.ts /** * Reference type. */ type Reference = (...args: any[]) => BaseSchema> | BaseSchemaAsync> | BaseValidation> | BaseValidationAsync> | BaseTransformation> | BaseTransformationAsync>; /** * Sets a specific error message. * * @param reference The identifier reference. * @param message The error message. * @param lang The language of the message. */ declare function setSpecificMessage(reference: TReference, message: ErrorMessage>>, lang?: string): void; /** * Returns a specific error message. * * @param reference The identifier reference. * @param lang The language of the message. * * @returns The error message. */ declare function getSpecificMessage(reference: TReference, lang?: string): ErrorMessage>> | undefined; /** * Deletes a specific error message. * * @param reference The identifier reference. * @param lang The language of the message. */ declare function deleteSpecificMessage(reference: Reference, lang?: string): void; //#endregion //#region src/utils/_addIssue/_addIssue.d.ts /** * Context type. */ type Context = BaseSchema> | BaseSchemaAsync> | BaseValidation> | BaseValidationAsync> | BaseTransformation> | BaseTransformationAsync>; /** * Other interface. */ interface Other { input?: unknown | undefined; expected?: string | undefined; received?: string | undefined; message?: ErrorMessage> | undefined; path?: [IssuePathItem, ...IssuePathItem[]] | undefined; issues?: [BaseIssue>, ...BaseIssue>[]] | undefined; } /** * Adds an issue to the dataset. * * @param context The issue context. * @param label The issue label. * @param dataset The input dataset. * @param config The configuration. * @param other The optional props. * * @internal */ declare function _addIssue(context: TContext & { expects?: string | null; requirement?: unknown; message?: ErrorMessage, { type: TContext["type"]; }>> | undefined; }, label: string, dataset: UnknownDataset | OutputDataset>, config: Config>, other?: Other): void; //#endregion //#region src/utils/_getByteCount/_getByteCount.d.ts /** * Returns the byte count of the input. * * @param input The input to be measured. * * @returns The byte count. * * @internal */ declare function _getByteCount(input: string): number; //#endregion //#region src/utils/_getGraphemeCount/_getGraphemeCount.d.ts /** * Returns the grapheme count of the input. * * @param input The input to be measured. * * @returns The grapheme count. * * @internal */ declare function _getGraphemeCount(input: string): number; //#endregion //#region src/utils/_getLastMetadata/_getLastMetadata.d.ts /** * Metadata action type. */ type MetadataAction$1 = TitleAction | DescriptionAction; /** * Schema type. */ type Schema$1 = BaseSchema> | BaseSchemaAsync> | SchemaWithPipe>, ...(PipeItem> | MetadataAction$1)[]]> | SchemaWithPipeAsync> | BaseSchemaAsync>), ...(PipeItem> | PipeItemAsync> | MetadataAction$1)[]]>; /** * Returns the last top-level value of a given metadata type from a schema * using a breadth-first search that starts with the last item in the pipeline. * * @param schema The schema to search. * @param type The metadata type. * * @returns The value, if any. * * @internal */ declare function _getLastMetadata(schema: Schema$1, type: "title" | "description"): string | undefined; //#endregion //#region src/utils/_getStandardProps/_getStandardProps.d.ts /** * Returns the Standard Schema properties. * * @param context The schema context. * * @returns The Standard Schema properties. */ declare function _getStandardProps> | BaseSchemaAsync>>(context: TSchema): StandardProps, InferOutput>; //#endregion //#region src/utils/_getWordCount/_getWordCount.d.ts /** * Returns the word count of the input. * * @param locales The locales to be used. * @param input The input to be measured. * * @returns The word count. * * @internal */ declare function _getWordCount(locales: Intl.LocalesArgument, input: string): number; //#endregion //#region src/utils/_isLuhnAlgo/_isLuhnAlgo.d.ts /** * Checks whether a string with numbers corresponds to the luhn algorithm. * * @param input The input to be checked. * * @returns Whether input is valid. * * @internal */ declare function _isLuhnAlgo(input: string): boolean; //#endregion //#region src/utils/_isValidObjectKey/_isValidObjectKey.d.ts /** * Disallows inherited object properties and prevents object prototype * pollution by disallowing certain keys. * * @param object The object to check. * @param key The key to check. * * @returns Whether the key is allowed. * * @internal */ declare function _isValidObjectKey(object: object, key: string): boolean; //#endregion //#region src/utils/_joinExpects/_joinExpects.d.ts /** * Joins multiple `expects` values with the given separator. * * @param values The `expects` values. * @param separator The separator. * * @returns The joined `expects` property. * * @internal */ declare function _joinExpects(values: string[], separator: "&" | "|"): string; //#endregion //#region src/utils/_stringify/_stringify.d.ts /** * Stringifies an unknown input to a literal or type string. * * @param input The unknown input. * * @returns A literal or type string. * * @internal */ declare function _stringify(input: unknown): string; //#endregion //#region src/utils/entriesFromList/entriesFromList.d.ts /** * Creates an object entries definition from a list of keys and a schema. * * @param list A list of keys. * @param schema The schema of the keys. * * @returns The object entries. */ declare function entriesFromList> | BaseSchemaAsync>>(list: TList, schema: TSchema): Record; //#endregion //#region src/utils/entriesFromObjects/entriesFromObjects.d.ts /** * Schema type. */ type Schema = LooseObjectSchema | undefined> | LooseObjectSchemaAsync | undefined> | ObjectSchema | undefined> | ObjectSchemaAsync | undefined> | ObjectWithRestSchema>, ErrorMessage | undefined> | ObjectWithRestSchemaAsync> | BaseSchemaAsync>, ErrorMessage | undefined> | StrictObjectSchema | undefined> | StrictObjectSchemaAsync | undefined>; /** * Recursive merge type. */ type RecursiveMerge = TSchemas extends readonly [infer TFirstSchema extends Schema] ? TFirstSchema["entries"] : TSchemas extends readonly [infer TFirstSchema extends Schema, ...infer TRestSchemas extends readonly [Schema, ...Schema[]]] ? Merge> : never; /** * Merged entries types. */ type MergedEntries = Prettify>; /** * Creates a new object entries definition from existing object schemas. * * @param schemas The schemas to merge the entries from. * * @returns The object entries from the schemas. */ declare function entriesFromObjects(schemas: TSchemas): MergedEntries; //#endregion //#region src/utils/getDotPath/getDotPath.d.ts /** * Creates and returns the dot path of an issue if possible. * * @param issue The issue to get the dot path from. * * @returns The dot path or null. */ declare function getDotPath(issue: BaseIssue): string | null; /** * Creates and returns the dot path of an issue if possible. * * @param issue The issue to get the dot path from. * * @returns The dot path or null. */ declare function getDotPath> | BaseSchemaAsync>>(issue: InferIssue): IssueDotPath | null; //#endregion //#region src/utils/isOfKind/isOfKind.d.ts /** * A generic type guard to check the kind of an object. * * @param kind The kind to check for. * @param object The object to check. * * @returns Whether it matches. */ declare function isOfKind(kind: TKind, object: TObject): object is Extract; //#endregion //#region src/utils/isOfType/isOfType.d.ts /** * A generic type guard to check the type of an object. * * @param type The type to check for. * @param object The object to check. * * @returns Whether it matches. */ declare function isOfType(type: TType, object: TObject): object is Extract; //#endregion //#region src/utils/isValiError/isValiError.d.ts /** * A type guard to check if an error is a ValiError. * * @param error The error to check. * * @returns Whether its a ValiError. */ declare function isValiError> | BaseSchemaAsync>>(error: unknown): error is ValiError; //#endregion //#region src/utils/ValiError/ValiError.d.ts /** * A Valibot error with useful information. */ declare class ValiError> | BaseSchemaAsync>> extends Error { /** * The error issues. */ readonly issues: [InferIssue, ...InferIssue[]]; /** * Creates a Valibot error with useful information. * * @param issues The error issues. */ constructor(issues: [InferIssue, ...InferIssue[]]); } //#endregion export { AnySchema, ArgsAction, ArgsActionAsync, ArrayInput, ArrayIssue, type ArrayPathItem, ArrayRequirement, ArrayRequirementAsync, ArraySchema, ArraySchemaAsync, AwaitActionAsync, BASE64_REGEX, BIC_REGEX, Base64Action, Base64Issue, type BaseIssue, type BaseMetadata, type BaseSchema, type BaseSchemaAsync, type BaseTransformation, type BaseTransformationAsync, type BaseValidation, type BaseValidationAsync, BicAction, BicIssue, BigintIssue, BigintSchema, BlobIssue, BlobSchema, BooleanIssue, BooleanSchema, Brand, BrandAction, BrandName, BrandSymbol, BytesAction, BytesIssue, CUID2_REGEX, CheckAction, CheckActionAsync, CheckIssue, CheckItemsAction, CheckItemsActionAsync, CheckItemsIssue, Class, type Config, ContentInput, ContentRequirement, CreditCardAction, CreditCardIssue, Cuid2Action, Cuid2Issue, CustomIssue, CustomSchema, CustomSchemaAsync, DECIMAL_REGEX, DIGITS_REGEX, DateIssue, DateSchema, DecimalAction, DecimalIssue, type Default, type DefaultAsync, type DefaultValue, DescriptionAction, DigitsAction, DigitsIssue, EMAIL_REGEX, EMOJI_REGEX, EmailAction, EmailIssue, EmojiAction, EmojiIssue, EmptyAction, EmptyIssue, EndsWithAction, EndsWithIssue, EntriesAction, EntriesInput, EntriesIssue, Enum, EnumIssue, EnumSchema, EnumValues, type ErrorMessage, EveryItemAction, EveryItemIssue, ExactOptionalSchema, ExactOptionalSchemaAsync, ExamplesAction, ExcludesAction, ExcludesIssue, type FailureDataset, Fallback, FallbackAsync, FileIssue, FileSchema, FilterItemsAction, FindItemAction, FiniteAction, FiniteIssue, FlatErrors, Flavor, FlavorAction, FlavorName, FlavorSymbol, FunctionIssue, FunctionSchema, type GenericIssue, type GenericMetadata, type GenericPipeAction, type GenericPipeActionAsync, type GenericPipeItem, type GenericPipeItemAsync, type GenericSchema, type GenericSchemaAsync, type GenericTransformation, type GenericTransformationAsync, type GenericValidation, type GenericValidationAsync, GlobalConfig, GraphemesAction, GraphemesIssue, GtValueAction, GtValueIssue, HEXADECIMAL_REGEX, HEX_COLOR_REGEX, HashAction, HashIssue, HashType, HexColorAction, HexColorIssue, HexadecimalAction, HexadecimalIssue, IMEI_REGEX, IPV4_REGEX, IPV6_REGEX, IP_REGEX, ISO_DATE_REGEX, ISO_DATE_TIME_REGEX, ISO_TIMESTAMP_REGEX, ISO_TIME_REGEX, ISO_TIME_SECOND_REGEX, ISO_WEEK_REGEX, ImeiAction, ImeiIssue, IncludesAction, IncludesIssue, InferDefault, InferDefaults, InferExamples, InferFallback, InferFallbacks, type InferInput, type InferIssue, InferMetadata, type InferOutput, InstanceIssue, InstanceSchema, IntegerAction, IntegerIssue, IntersectIssue, IntersectOptions, IntersectOptionsAsync, IntersectSchema, IntersectSchemaAsync, IpAction, IpIssue, Ipv4Action, Ipv4Issue, Ipv6Action, Ipv6Issue, IsoDateAction, IsoDateIssue, IsoDateTimeAction, IsoDateTimeIssue, IsoTimeAction, IsoTimeIssue, IsoTimeSecondAction, IsoTimeSecondIssue, IsoTimestampAction, IsoTimestampIssue, IsoWeekAction, IsoWeekIssue, type IssueDotPath, type IssuePathItem, LazySchema, LazySchemaAsync, LengthAction, LengthInput, LengthIssue, Literal, LiteralIssue, LiteralSchema, LooseObjectIssue, LooseObjectSchema, LooseObjectSchemaAsync, LooseTupleIssue, LooseTupleSchema, LooseTupleSchemaAsync, LtValueAction, LtValueIssue, MAC48_REGEX, MAC64_REGEX, MAC_REGEX, Mac48Action, Mac48Issue, Mac64Action, Mac64Issue, MacAction, MacIssue, MapIssue, MapItemsAction, type MapPathItem, MapSchema, MapSchemaAsync, MaxBytesAction, MaxBytesIssue, MaxEntriesAction, MaxEntriesIssue, MaxGraphemesAction, MaxGraphemesIssue, MaxLengthAction, MaxLengthIssue, MaxSizeAction, MaxSizeIssue, MaxValueAction, MaxValueIssue, MaxWordsAction, MaxWordsIssue, MetadataAction, MimeTypeAction, MimeTypeIssue, MinBytesAction, MinBytesIssue, MinEntriesAction, MinEntriesIssue, MinGraphemesAction, MinGraphemesIssue, MinLengthAction, MinLengthIssue, MinSizeAction, MinSizeIssue, MinValueAction, MinValueIssue, MinWordsAction, MinWordsIssue, MultipleOfAction, MultipleOfIssue, NANO_ID_REGEX, NanIssue, NanSchema, NanoIDAction, NanoIDIssue, NanoIdAction, NanoIdIssue, NeverIssue, NeverSchema, NonEmptyAction, NonEmptyIssue, NonNullableIssue, NonNullableSchema, NonNullableSchemaAsync, NonNullishIssue, NonNullishSchema, NonNullishSchemaAsync, NonOptionalIssue, NonOptionalSchema, NonOptionalSchemaAsync, NormalizeAction, NormalizeForm, NotBytesAction, NotBytesIssue, NotEntriesAction, NotEntriesIssue, NotGraphemesAction, NotGraphemesIssue, NotLengthAction, NotLengthIssue, NotSizeAction, NotSizeIssue, NotValueAction, NotValueIssue, NotValuesAction, NotValuesIssue, NotWordsAction, NotWordsIssue, NullIssue, NullSchema, NullableSchema, NullableSchemaAsync, NullishSchema, NullishSchemaAsync, NumberIssue, NumberSchema, OCTAL_REGEX, type ObjectEntries, type ObjectEntriesAsync, ObjectIssue, type ObjectKeys, type ObjectPathItem, ObjectSchema, ObjectSchemaAsync, ObjectWithRestIssue, ObjectWithRestSchema, ObjectWithRestSchemaAsync, OctalAction, OctalIssue, OptionalSchema, OptionalSchemaAsync, type OutputDataset, ParseJsonAction, ParseJsonConfig, ParseJsonIssue, Parser, ParserAsync, PartialCheckAction, PartialCheckActionAsync, PartialCheckIssue, type PartialDataset, PicklistIssue, PicklistOptions, PicklistSchema, type PipeAction, type PipeActionAsync, type PipeItem, type PipeItemAsync, PromiseIssue, PromiseSchema, RFC_EMAIL_REGEX, RawCheckAction, RawCheckActionAsync, RawCheckAddIssue, RawCheckContext, RawCheckIssue, RawCheckIssueInfo, RawTransformAction, RawTransformActionAsync, RawTransformAddIssue, RawTransformContext, RawTransformIssue, RawTransformIssueInfo, ReadonlyAction, RecordIssue, RecordSchema, RecordSchemaAsync, ReduceItemsAction, RegexAction, RegexIssue, ReturnsAction, ReturnsActionAsync, RfcEmailAction, RfcEmailIssue, SLUG_REGEX, SafeIntegerAction, SafeIntegerIssue, SafeParseResult, SafeParser, SafeParserAsync, SchemaWithFallback, SchemaWithFallbackAsync, SchemaWithOmit, SchemaWithPartial, SchemaWithPartialAsync, SchemaWithPick, SchemaWithPipe, SchemaWithPipeAsync, SchemaWithRequired, SchemaWithRequiredAsync, type SchemaWithoutPipe, SetIssue, type SetPathItem, SetSchema, SetSchemaAsync, SizeAction, SizeInput, SizeIssue, SlugAction, SlugIssue, SomeItemAction, SomeItemIssue, SortItemsAction, type StandardProps, StartsWithAction, StartsWithIssue, StrictObjectIssue, StrictObjectSchema, StrictObjectSchemaAsync, StrictTupleIssue, StrictTupleSchema, StrictTupleSchemaAsync, StringIssue, StringSchema, StringifyJsonAction, StringifyJsonConfig, StringifyJsonIssue, type SuccessDataset, SymbolIssue, SymbolSchema, TitleAction, ToBigintAction, ToBigintIssue, ToBooleanAction, ToDateAction, ToDateIssue, ToLowerCaseAction, ToMaxValueAction, ToMinValueAction, ToNumberAction, ToNumberIssue, ToStringAction, ToStringIssue, ToUpperCaseAction, TransformAction, TransformActionAsync, TrimAction, TrimEndAction, TrimStartAction, TupleIssue, type TupleItems, type TupleItemsAsync, TupleSchema, TupleSchemaAsync, TupleWithRestIssue, TupleWithRestSchema, TupleWithRestSchemaAsync, ULID_REGEX, UUID_REGEX, UlidAction, UlidIssue, UndefinedIssue, UndefinedSchema, UndefinedableSchema, UndefinedableSchemaAsync, UnionIssue, UnionOptions, UnionOptionsAsync, UnionSchema, UnionSchemaAsync, type UnknownDataset, type UnknownPathItem, UnknownSchema, UrlAction, UrlIssue, UuidAction, UuidIssue, ValiError, ValueAction, ValueInput, ValueIssue, ValuesAction, ValuesIssue, VariantIssue, VariantOptions, VariantOptionsAsync, VariantSchema, VariantSchemaAsync, VoidIssue, VoidSchema, WordsAction, WordsIssue, _addIssue, _getByteCount, _getGraphemeCount, _getLastMetadata, _getStandardProps, _getWordCount, _isLuhnAlgo, _isValidObjectKey, _joinExpects, _stringify, any, args, argsAsync, array, arrayAsync, assert, awaitAsync, base64, bic, bigint, blob, boolean, brand, bytes, check, checkAsync, checkItems, checkItemsAsync, config, creditCard, cuid2, custom, customAsync, date, decimal, deleteGlobalConfig, deleteGlobalMessage, deleteSchemaMessage, deleteSpecificMessage, description, digits, email, emoji, empty, endsWith, entries, entriesFromList, entriesFromObjects, enum_ as enum, enum_, everyItem, exactOptional, exactOptionalAsync, examples, excludes, fallback, fallbackAsync, file, filterItems, findItem, finite, flatten, flavor, forward, forwardAsync, function_ as function, function_, getDefault, getDefaults, getDefaultsAsync, getDescription, getDotPath, getExamples, getFallback, getFallbacks, getFallbacksAsync, getGlobalConfig, getGlobalMessage, getMetadata, getSchemaMessage, getSpecificMessage, getTitle, graphemes, gtValue, hash, hexColor, hexadecimal, imei, includes, instance, integer, intersect, intersectAsync, ip, ipv4, ipv6, is, isOfKind, isOfType, isValiError, isoDate, isoDateTime, isoTime, isoTimeSecond, isoTimestamp, isoWeek, keyof, lazy, lazyAsync, length, literal, looseObject, looseObjectAsync, looseTuple, looseTupleAsync, ltValue, mac, mac48, mac64, map, mapAsync, mapItems, maxBytes, maxEntries, maxGraphemes, maxLength, maxSize, maxValue, maxWords, message, metadata, mimeType, minBytes, minEntries, minGraphemes, minLength, minSize, minValue, minWords, multipleOf, nan, nanoid, never, nonEmpty, nonNullable, nonNullableAsync, nonNullish, nonNullishAsync, nonOptional, nonOptionalAsync, normalize, notBytes, notEntries, notGraphemes, notLength, notSize, notValue, notValues, notWords, null_ as null, null_, nullable, nullableAsync, nullish, nullishAsync, number, object, objectAsync, objectWithRest, objectWithRestAsync, octal, omit, optional, optionalAsync, parse, parseAsync, parseJson, parser, parserAsync, partial, partialAsync, partialCheck, partialCheckAsync, pick, picklist, pipe, pipeAsync, promise, rawCheck, rawCheckAsync, rawTransform, rawTransformAsync, readonly, record, recordAsync, reduceItems, regex, required, requiredAsync, returns, returnsAsync, rfcEmail, safeInteger, safeParse, safeParseAsync, safeParser, safeParserAsync, set, setAsync, setGlobalConfig, setGlobalMessage, setSchemaMessage, setSpecificMessage, size, slug, someItem, sortItems, startsWith, strictObject, strictObjectAsync, strictTuple, strictTupleAsync, string, stringifyJson, summarize, symbol, title, toBigint, toBoolean, toDate, toLowerCase, toMaxValue, toMinValue, toNumber, toString, toUpperCase, transform, transformAsync, trim, trimEnd, trimStart, tuple, tupleAsync, tupleWithRest, tupleWithRestAsync, ulid, undefined_ as undefined, undefined_, undefinedable, undefinedableAsync, union, unionAsync, unknown, unwrap, url, uuid, value, values, variant, variantAsync, void_ as void, void_, words };