Function stringFormat

Parameters

• format: Format
• fnOrRegex: RegExp | ((arg: string) => unknown)
• Optional_params:
      | string
      | {
          abort?: boolean;
          error?: | string
          | $ZodErrorMap<
              NonNullable<
                  $ZodIssueInvalidType<unknown>
                  | $ZodIssueInvalidStringFormat,
              >,
          >;
          message?: string;
      }
  • string
  • {
        abort?: boolean;
        error?:
            | string
            | $ZodErrorMap<
                NonNullable<
                    $ZodIssueInvalidType<unknown>
                    | $ZodIssueInvalidStringFormat,
                >,
            >;
        message?: string;
    }

    • Optionalabort?: boolean

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

    • Optionalerror?:
          | string
          | $ZodErrorMap<
              NonNullable<
                  $ZodIssueInvalidType<unknown>
                  | $ZodIssueInvalidStringFormat,
              >,
          >

    • Optionalmessage?: string

      Deprecated

      This parameter is deprecated. Use error instead.