Variable InputTypeConst

Type declaration

• enum: {
      <const T extends readonly string[]>(
          values: T,
          params?:
              | string
              | {
                  error?: string
                  | $ZodErrorMap<$ZodIssueInvalidValue<unknown>>;
                  message?: string;
              },
      ): ZodEnum<{ [k in string]: { [k in string]: k }[k] }>;
      <const T extends Readonly<Record<string, EnumValue>>>(
          entries: T,
          params?:
              | string
              | {
                  error?: string
                  | $ZodErrorMap<$ZodIssueInvalidValue<unknown>>;
                  message?: string;
              },
      ): ZodEnum<T>;
  }

• bigint: function

  • bigint<T = unknown>(
        params?:
            | string
            | {
                coerce?: boolean;
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
                message?: string;
            },
    ): ZodCoercedBigInt<T>

    Type Parameters

    • T = unknown

    Parameters

    • Optionalparams:
          | string
          | {
              coerce?: boolean;
              error?: string
              | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
              message?: string;
          }
      • string
      • {
            coerce?: boolean;
            error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
            message?: string;
        }

        • Optionalcoerce?: boolean

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

        • Optionalmessage?: string

          Deprecated

          This parameter is deprecated. Use error instead.

    Returns ZodCoercedBigInt<T>

• boolean: function

  • boolean<T = unknown>(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
                message?: string;
            },
    ): ZodCoercedBoolean<T>

    Type Parameters

    • T = unknown

    Parameters

    • Optionalparams:
          | string
          | {
              error?: string
              | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
              message?: string;
          }
      • string
      • {
            error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
            message?: string;
        }

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

        • Optionalmessage?: string

          Deprecated

          This parameter is deprecated. Use error instead.

    Returns ZodCoercedBoolean<T>

• date: function

  • date<T = unknown>(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
                message?: string;
            },
    ): ZodCoercedDate<T>

    Type Parameters

    • T = unknown

    Parameters

    • Optionalparams:
          | string
          | {
              error?: string
              | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
              message?: string;
          }
      • string
      • {
            error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
            message?: string;
        }

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

        • Optionalmessage?: string

          Deprecated

          This parameter is deprecated. Use error instead.

    Returns ZodCoercedDate<T>

• number: function

  • number<T = unknown>(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
                message?: string;
            },
    ): ZodCoercedNumber<T>

    Type Parameters

    • T = unknown

    Parameters

    • Optionalparams:
          | string
          | {
              error?: string
              | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
              message?: string;
          }
      • string
      • {
            error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
            message?: string;
        }

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

        • Optionalmessage?: string

          Deprecated

          This parameter is deprecated. Use error instead.

    Returns ZodCoercedNumber<T>

• string: function

  • string<T = unknown>(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
                message?: string;
            },
    ): ZodCoercedString<T>

    Type Parameters

    • T = unknown

    Parameters

    • Optionalparams:
          | string
          | {
              error?: string
              | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
              message?: string;
          }
      • string
      • {
            error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
            message?: string;
        }

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

        • Optionalmessage?: string

          Deprecated

          This parameter is deprecated. Use error instead.

    Returns ZodCoercedString<T>