@karmaniverous/get-dotenv
    Preparing search index...

    Interface ZodNullable<T>

    interface ZodNullable<T extends SomeType = z.core.$ZodType> {
        _def: $ZodNullableDef<T>;
        _input: z.core.input<T> | null;
        _output: z.core.output<T> | null;
        _zod: $ZodNullableInternals;
        "~standard": z.ZodStandardSchemaWithJSON<z.ZodNullable<T>>;
        def: $ZodNullableDef<T>;
        description?: string;
        spa: (
            data: unknown,
            params?: ParseContext<$ZodIssue>,
        ) => Promise<ZodSafeParseResult<z.core.output<T> | null>>;
        type: "nullable";
        and<T extends SomeType>(
            incoming: T,
        ): z.ZodIntersection<z.ZodNullable<T>, T>;
        apply<T>(fn: (schema: this) => T): T;
        array(): z.ZodArray<z.ZodNullable<T>>;
        brand<
            T extends PropertyKey = PropertyKey,
            Dir extends "out" | "in" | "inout" = "out",
        >(
            value?: T,
        ): PropertyKey extends T
            ? z.ZodNullable<T>
            : $ZodBranded<z.ZodNullable<T>, T, Dir>;
        catch(def: z.core.output<T> | null): z.ZodCatch<z.ZodNullable<T>>;
        catch(
            def: (ctx: $ZodCatchCtx) => z.core.output<T> | null,
        ): z.ZodCatch<z.ZodNullable<T>>;
        check(
            ...checks: (
                | CheckFn<z.core.output<T> | null>
                | z.core.$ZodCheck<z.core.output<T> | null>
            )[],
        ): this;
        clone(def?: $ZodNullableDef<T>, params?: { parent: boolean }): this;
        decode(
            data: z.core.input<T> | null,
            params?: ParseContext<$ZodIssue>,
        ): z.core.output<T> | null;
        decodeAsync(
            data: z.core.input<T> | null,
            params?: ParseContext<$ZodIssue>,
        ): Promise<z.core.output<T> | null>;
        default(
            def: NoUndefined<z.core.output<T>> | null,
        ): z.ZodDefault<z.ZodNullable<T>>;
        default(
            def: () => NoUndefined<z.core.output<T>> | null,
        ): z.ZodDefault<z.ZodNullable<T>>;
        describe(description: string): this;
        encode(
            data: z.core.output<T> | null,
            params?: ParseContext<$ZodIssue>,
        ): z.core.input<T> | null;
        encodeAsync(
            data: z.core.output<T> | null,
            params?: ParseContext<$ZodIssue>,
        ): Promise<z.core.input<T> | null>;
        exactOptional(): z.ZodExactOptional<z.ZodNullable<T>>;
        isNullable(): boolean;
        isOptional(): boolean;
        meta(): | {
            deprecated?: boolean;
            description?: string;
            id?: string;
            title?: string;
            [key: string]: unknown;
        }
        | undefined;
        meta(
            data: {
                deprecated?: boolean;
                description?: string;
                id?: string;
                title?: string;
                [key: string]: unknown;
            },
        ): this;
        nonoptional(
            params?:
                | string
                | {
                    error?: string
                    | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
                    message?: string;
                },
        ): z.ZodNonOptional<z.ZodNullable<T>>;
        nullable(): z.ZodNullable<z.ZodNullable<T>>;
        nullish(): z.ZodOptional<z.ZodNullable<z.ZodNullable<T>>>;
        optional(): z.ZodOptional<z.ZodNullable<T>>;
        or<T extends SomeType>(option: T): z.ZodUnion<[z.ZodNullable<T>, T]>;
        overwrite(
            fn: (x: z.core.output<T> | null) => z.core.output<T> | null,
        ): this;
        parse(
            data: unknown,
            params?: ParseContext<$ZodIssue>,
        ): z.core.output<T> | null;
        parseAsync(
            data: unknown,
            params?: ParseContext<$ZodIssue>,
        ): Promise<z.core.output<T> | null>;
        pipe<
            T extends
                z.core.$ZodType<
                    any,
                    z.core.output<T>
                    | null,
                    $ZodTypeInternals<any, z.core.output<T> | null>,
                >,
        >(
            target:
                | T
                | z.core.$ZodType<
                    any,
                    z.core.output<T>
                    | null,
                    $ZodTypeInternals<any, z.core.output<T> | null>,
                >,
        ): z.ZodPipe<z.ZodNullable<T>, T>;
        prefault(
            def: () => z.core.input<T> | null,
        ): z.ZodPrefault<z.ZodNullable<T>>;
        prefault(def: z.core.input<T> | null): z.ZodPrefault<z.ZodNullable<T>>;
        readonly(): z.ZodReadonly<z.ZodNullable<T>>;
        refine<Ch extends (arg: z.core.output<T> | null) => unknown>(
            check: Ch,
            params?:
                | string
                | {
                    abort?: boolean;
                    error?: string
                    | $ZodErrorMap<NonNullable<$ZodIssue>>;
                    message?: string;
                    params?: Record<string, any>;
                    path?: PropertyKey[];
                    when?: (payload: ParsePayload) => boolean;
                },
        ): Ch extends (arg: any) => arg is R
            ? z.ZodNullable<T> & z.ZodType<
                R,
                z.core.input<T>
                | null,
                $ZodTypeInternals<R, z.core.input<T> | null>,
            >
            : z.ZodNullable<T>;
        register<
            R extends
                $ZodRegistry<
                    MetadataType,
                    z.core.$ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
                >,
        >(
            registry: R,
            ...meta: z.ZodNullable<T> extends R["_schema"]
                ? undefined extends R["_meta"]
                    ? [$replace<R["_meta"], R["_schema"] & z.ZodNullable<T>>?]
                    : [$replace<R["_meta"], R["_schema"] & z.ZodNullable<T>>]
                : ["Incompatible schema"],
        ): this;
        safeDecode(
            data: z.core.input<T> | null,
            params?: ParseContext<$ZodIssue>,
        ): ZodSafeParseResult<z.core.output<T> | null>;
        safeDecodeAsync(
            data: z.core.input<T> | null,
            params?: ParseContext<$ZodIssue>,
        ): Promise<ZodSafeParseResult<z.core.output<T> | null>>;
        safeEncode(
            data: z.core.output<T> | null,
            params?: ParseContext<$ZodIssue>,
        ): ZodSafeParseResult<z.core.input<T> | null>;
        safeEncodeAsync(
            data: z.core.output<T> | null,
            params?: ParseContext<$ZodIssue>,
        ): Promise<ZodSafeParseResult<z.core.input<T> | null>>;
        safeParse(
            data: unknown,
            params?: ParseContext<$ZodIssue>,
        ): ZodSafeParseResult<z.core.output<T> | null>;
        safeParseAsync(
            data: unknown,
            params?: ParseContext<$ZodIssue>,
        ): Promise<ZodSafeParseResult<z.core.output<T> | null>>;
        superRefine(
            refinement: (
                arg: z.core.output<T> | null,
                ctx: $RefinementCtx<z.core.output<T> | null>,
            ) => void | Promise<void>,
            params?: $ZodSuperRefineParams,
        ): this;
        toJSONSchema(
            params?: ToJSONSchemaParams,
        ): ZodStandardJSONSchemaPayload<z.ZodNullable<T>>;
        transform<NewOut>(
            transform: (
                arg: z.core.output<T> | null,
                ctx: $RefinementCtx<z.core.output<T> | null>,
            ) => NewOut | Promise<NewOut>,
        ): z.ZodPipe<
            z.ZodNullable<T>,
            z.ZodTransform<Awaited<NewOut>, z.core.output<T> | null>,
        >;
        unwrap(): T;
        with(
            ...checks: (
                | CheckFn<z.core.output<T> | null>
                | z.core.$ZodCheck<z.core.output<T> | null>
            )[],
        ): this;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    _def _input _output _zod ~standard def description? spa type

    Methods

    and apply array brand catch check clone decode decodeAsync default describe encode encodeAsync exactOptional isNullable isOptional meta nonoptional nullable nullish optional or overwrite parse parseAsync pipe prefault readonly refine register safeDecode safeDecodeAsync safeEncode safeEncodeAsync safeParse safeParseAsync superRefine toJSONSchema transform unwrap with

    Properties

    _def

    _def: $ZodNullableDef<T>

    Use .def instead.

    _input

    _input: z.core.input<T> | null

    Use z.input<typeof schema> instead.

    _output

    _output: z.core.output<T> | null

    Use z.output<typeof schema> instead.

    _zod

    _zod: $ZodNullableInternals
    "~standard": z.ZodStandardSchemaWithJSON<z.ZodNullable<T>>
    def: $ZodNullableDef<T>
    description?: string
    spa: (
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ) => Promise<ZodSafeParseResult<z.core.output<T> | null>>
    type: "nullable"

    Methods

    • Type Parameters

      • T

      Parameters

      • fn: (schema: this) => T

      Returns T

    • Parameters

      Returns this

    • Returns a new instance that has been registered in z.globalRegistry with the specified description

      Parameters

      • description: string

      Returns this

    • Returns boolean

      Try safe-parsing null (this is what isNullable does internally):

      const schema = z.string().nullable();
      const isNullable = schema.safeParse(null).success; // true

    • Returns boolean

      Try safe-parsing undefined (this is what isOptional does internally):

      const schema = z.string().optional();
      const isOptional = schema.safeParse(undefined).success; // true

    • Returns the metadata associated with this instance in z.globalRegistry

      Returns
          | {
              deprecated?: boolean;
              description?: string;
              id?: string;
              title?: string;
              [key: string]: unknown;
          }
          | undefined

    • Returns a new instance that has been registered in z.globalRegistry with the specified metadata

      Parameters

      • data: {
            deprecated?: boolean;
            description?: string;
            id?: string;
            title?: string;
            [key: string]: unknown;
        }

      Returns this

    • Type Parameters

      Parameters

      • check: Ch
      • Optionalparams:
            | string
            | {
                abort?: boolean;
                error?: string
                | $ZodErrorMap<NonNullable<$ZodIssue>>;
                message?: string;
                params?: Record<string, any>;
                path?: PropertyKey[];
                when?: (payload: ParsePayload) => boolean;
            }
        • string
        • {
              abort?: boolean;
              error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>;
              message?: string;
              params?: Record<string, any>;
              path?: PropertyKey[];
              when?: (payload: ParsePayload) => boolean;
          }
          • Optionalabort?: boolean

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

          • Optionalerror?: string | $ZodErrorMap<NonNullable<$ZodIssue>>
          • Optionalmessage?: string

            This parameter is deprecated. Use error instead.

          • Optionalparams?: Record<string, any>
          • Optionalpath?: PropertyKey[]
          • Optionalwhen?: (payload: ParsePayload) => boolean

            If provided, the check runs only when this returns true. By default, it is skipped if prior parsing produced aborting issues.

      Returns Ch extends (arg: any) => arg is R
          ? z.ZodNullable<T> & z.ZodType<
              R,
              z.core.input<T>
              | null,
              $ZodTypeInternals<R, z.core.input<T> | null>,
          >
          : z.ZodNullable<T>

    • Returns T

    Settings

    Member Visibility

    On This Page

    Properties
    Methods