Skip to main content

Function: stringFormat()

stringFormat<Format>(format, fnOrRegex, _params?): ZodCustomStringFormat<Format>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:301

Type Parameters​

Format​

Format extends string

Parameters​

format​

Format

fnOrRegex​

RegExp | (arg) => unknown

_params?​

string |

{ abort?: boolean; error?: string | $ZodErrorMap<NonNullable<$ZodIssueInvalidType<unknown> | $ZodIssueInvalidStringFormat>>; message?: string; }

abort?​

boolean

If true, no later checks will be executed if this check fails. Default false.

error?​

string | $ZodErrorMap<NonNullable<$ZodIssueInvalidType<unknown> | $ZodIssueInvalidStringFormat>>

message?​

string

Deprecated

This parameter is deprecated. Use error instead.

Returns​

ZodCustomStringFormat<Format>