Class ZodBigInt

Hierarchy (View Summary)

Zod.ZodType<bigint, Zod.ZodBigIntDef>
- ZodBigInt

Index

Constructors

constructor

new ZodBigInt(def: Zod.ZodBigIntDef): Zod.ZodBigInt
Parameters
- def: Zod.ZodBigIntDef
Returns Zod.ZodBigInt
Inherited from ZodType.constructor

Properties

`Readonly`_def

_def: Zod.ZodBigIntDef

`Readonly`_input

_input: bigint

`Readonly`_output

_output: bigint

`Readonly`_type

_type: bigint

max

max: (value: bigint, message?: ErrMessage) => Zod.ZodBigInt

min

min: (value: bigint, message?: ErrMessage) => Zod.ZodBigInt

spa

spa: (
data: unknown,
params?: Partial<Zod.ParseParams>,
) => Promise<Zod.SafeParseReturnType<bigint, bigint>>

Alias of safeParseAsync

`Static`create

create: (
    params?: {
        description?: string;
        errorMap?: Zod.ZodErrorMap;
        invalid_type_error?: string;
        required_error?: string;
    } & { coerce?: boolean },
) => Zod.ZodBigInt

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description

maxValue

get maxValue(): null | bigint
Returns null | bigint

minValue

get minValue(): null | bigint
Returns null | bigint

Methods

_addCheck

_addCheck(check: Zod.ZodBigIntCheck): Zod.ZodBigInt
Parameters
- check: Zod.ZodBigIntCheck
Returns Zod.ZodBigInt

_getOrReturnCtx

_getOrReturnCtx(input: Zod.ParseInput, ctx?: Zod.ParseContext): Zod.ParseContext
Parameters
- input: Zod.ParseInput
- Optionalctx: Zod.ParseContext
Returns Zod.ParseContext
Inherited from ZodType._getOrReturnCtx

_getType

_getType(input: Zod.ParseInput): string
Parameters
- input: Zod.ParseInput
Returns string
Inherited from ZodType._getType

_parse

_parse(input: Zod.ParseInput): Zod.ParseReturnType<bigint>
Parameters
- input: Zod.ParseInput
Returns Zod.ParseReturnType<bigint>
Overrides ZodType._parse

_parseAsync

_parseAsync(input: Zod.ParseInput): Zod.AsyncParseReturnType<bigint>
Parameters
- input: Zod.ParseInput
Returns Zod.AsyncParseReturnType<bigint>
Inherited from ZodType._parseAsync

_parseSync

_parseSync(input: Zod.ParseInput): Zod.SyncParseReturnType<bigint>
Parameters
- input: Zod.ParseInput
Returns Zod.SyncParseReturnType<bigint>
Inherited from ZodType._parseSync

_processInputParams

_processInputParams(
input: Zod.ParseInput,
): { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Parameters
- input: Zod.ParseInput
Returns { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Inherited from ZodType._processInputParams

_refinement

_refinement(
refinement: (arg: bigint, ctx: Zod.RefinementCtx) => any,
): Zod.ZodEffects<Zod.ZodBigInt, bigint, bigint>
Parameters
- refinement: (arg: bigint, ctx: Zod.RefinementCtx) => any
Returns Zod.ZodEffects<Zod.ZodBigInt, bigint, bigint>
Inherited from ZodType._refinement

and

and<T extends Zod.ZodTypeAny>(
incoming: T,
): Zod.ZodIntersection<Zod.ZodBigInt, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- incoming: T
Returns Zod.ZodIntersection<Zod.ZodBigInt, T>
Inherited from ZodType.and

array

array(): Zod.ZodArray<Zod.ZodBigInt>
Returns Zod.ZodArray<Zod.ZodBigInt>
Inherited from ZodType.array

brand

brand<B extends string | number | symbol>(
brand?: B,
): Zod.ZodBranded<Zod.ZodBigInt, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns Zod.ZodBranded<Zod.ZodBigInt, B>
Inherited from ZodType.brand

catch

catch(def: bigint): Zod.ZodCatch<Zod.ZodBigInt>
Parameters
- def: bigint
Returns Zod.ZodCatch<Zod.ZodBigInt>
Inherited from ZodType.catch
catch(
def: (ctx: { error: Zod.ZodError; input: bigint }) => bigint,
): Zod.ZodCatch<Zod.ZodBigInt>
Parameters
- def: (ctx: { error: Zod.ZodError; input: bigint }) => bigint
Returns Zod.ZodCatch<Zod.ZodBigInt>
Inherited from ZodType.catch

default

default(def: bigint): Zod.ZodDefault<Zod.ZodBigInt>
Parameters
- def: bigint
Returns Zod.ZodDefault<Zod.ZodBigInt>
Inherited from ZodType.default
default(def: () => bigint): Zod.ZodDefault<Zod.ZodBigInt>
Parameters
- def: () => bigint
Returns Zod.ZodDefault<Zod.ZodBigInt>
Inherited from ZodType.default

describe

describe(description: string): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe

gt

gt(value: bigint, message?: ErrMessage): Zod.ZodBigInt
Parameters
- value: bigint
- Optionalmessage: ErrMessage
Returns Zod.ZodBigInt

gte

gte(value: bigint, message?: ErrMessage): Zod.ZodBigInt
Parameters
- value: bigint
- Optionalmessage: ErrMessage
Returns Zod.ZodBigInt

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional

lt

lt(value: bigint, message?: ErrMessage): Zod.ZodBigInt
Parameters
- value: bigint
- Optionalmessage: ErrMessage
Returns Zod.ZodBigInt

lte

lte(value: bigint, message?: ErrMessage): Zod.ZodBigInt
Parameters
- value: bigint
- Optionalmessage: ErrMessage
Returns Zod.ZodBigInt

multipleOf

multipleOf(value: bigint, message?: ErrMessage): Zod.ZodBigInt
Parameters
- value: bigint
- Optionalmessage: ErrMessage
Returns Zod.ZodBigInt

negative

negative(message?: ErrMessage): Zod.ZodBigInt
Parameters
- Optionalmessage: ErrMessage
Returns Zod.ZodBigInt

nonnegative

nonnegative(message?: ErrMessage): Zod.ZodBigInt
Parameters
- Optionalmessage: ErrMessage
Returns Zod.ZodBigInt

nonpositive

nonpositive(message?: ErrMessage): Zod.ZodBigInt
Parameters
- Optionalmessage: ErrMessage
Returns Zod.ZodBigInt

or

or<T extends Zod.ZodTypeAny>(option: T): Zod.ZodUnion<[Zod.ZodBigInt, T]>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- option: T
Returns Zod.ZodUnion<[Zod.ZodBigInt, T]>
Inherited from ZodType.or

parse

parse(data: unknown, params?: Partial<Zod.ParseParams>): bigint
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns bigint
Inherited from ZodType.parse

parseAsync

parseAsync(data: unknown, params?: Partial<Zod.ParseParams>): Promise<bigint>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<bigint>
Inherited from ZodType.parseAsync

pipe

pipe<T extends Zod.ZodTypeAny>(target: T): Zod.ZodPipeline<Zod.ZodBigInt, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- target: T
Returns Zod.ZodPipeline<Zod.ZodBigInt, T>
Inherited from ZodType.pipe

positive

positive(message?: ErrMessage): Zod.ZodBigInt
Parameters
- Optionalmessage: ErrMessage
Returns Zod.ZodBigInt

promise

promise(): Zod.ZodPromise<Zod.ZodBigInt>
Returns Zod.ZodPromise<Zod.ZodBigInt>
Inherited from ZodType.promise

readonly

readonly(): Zod.ZodReadonly<Zod.ZodBigInt>
Returns Zod.ZodReadonly<Zod.ZodBigInt>
Inherited from ZodType.readonly

refine

refine<RefinedOutput extends bigint>(
    check: (arg: bigint) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: bigint) => Zod.CustomErrorParams),
): Zod.ZodEffects<Zod.ZodBigInt, RefinedOutput, bigint>
Type Parameters
- RefinedOutput extends bigint
Parameters
- check: (arg: bigint) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<Zod.ZodCustomIssue, "code">>
      | ((arg: bigint) => Zod.CustomErrorParams)
Returns Zod.ZodEffects<Zod.ZodBigInt, RefinedOutput, bigint>
Inherited from ZodType.refine
refine(
    check: (arg: bigint) => unknown,
    message?:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: bigint) => Zod.CustomErrorParams),
): Zod.ZodEffects<Zod.ZodBigInt, bigint, bigint>
Parameters
- check: (arg: bigint) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<Zod.ZodCustomIssue, "code">>
      | ((arg: bigint) => Zod.CustomErrorParams)
Returns Zod.ZodEffects<Zod.ZodBigInt, bigint, bigint>
Inherited from ZodType.refine

refinement<RefinedOutput extends bigint>(
    check: (arg: bigint) => arg is RefinedOutput,
    refinementData:
        | Zod.IssueData
        | ((arg: bigint, ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<Zod.ZodBigInt, RefinedOutput, bigint>
Type Parameters
- RefinedOutput extends bigint
Parameters
- check: (arg: bigint) => arg is RefinedOutput
- refinementData: Zod.IssueData | ((arg: bigint, ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<Zod.ZodBigInt, RefinedOutput, bigint>
Inherited from ZodType.refinement
refinement(
    check: (arg: bigint) => boolean,
    refinementData:
        | Zod.IssueData
        | ((arg: bigint, ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<Zod.ZodBigInt, bigint, bigint>
Parameters
- check: (arg: bigint) => boolean
- refinementData: Zod.IssueData | ((arg: bigint, ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<Zod.ZodBigInt, bigint, bigint>
Inherited from ZodType.refinement

safeParse

safeParse(
data: unknown,
params?: Partial<Zod.ParseParams>,
): Zod.SafeParseReturnType<bigint, bigint>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Zod.SafeParseReturnType<bigint, bigint>
Inherited from ZodType.safeParse

safeParseAsync

safeParseAsync(
data: unknown,
params?: Partial<Zod.ParseParams>,
): Promise<Zod.SafeParseReturnType<bigint, bigint>>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<Zod.SafeParseReturnType<bigint, bigint>>
Inherited from ZodType.safeParseAsync

superRefine

superRefine<RefinedOutput extends bigint>(
    refinement: (
        arg: bigint,
        ctx: Zod.RefinementCtx,
    ) => arg is RefinedOutput,
): Zod.ZodEffects<Zod.ZodBigInt, RefinedOutput, bigint>
Type Parameters
- RefinedOutput extends bigint
Parameters
- refinement: (arg: bigint, ctx: Zod.RefinementCtx) => arg is RefinedOutput
Returns Zod.ZodEffects<Zod.ZodBigInt, RefinedOutput, bigint>
Inherited from ZodType.superRefine
superRefine(
refinement: (arg: bigint, ctx: Zod.RefinementCtx) => void,
): Zod.ZodEffects<Zod.ZodBigInt, bigint, bigint>
Parameters
- refinement: (arg: bigint, ctx: Zod.RefinementCtx) => void
Returns Zod.ZodEffects<Zod.ZodBigInt, bigint, bigint>
Inherited from ZodType.superRefine
superRefine(
refinement: (arg: bigint, ctx: Zod.RefinementCtx) => Promise<void>,
): Zod.ZodEffects<Zod.ZodBigInt, bigint, bigint>
Parameters
- refinement: (arg: bigint, ctx: Zod.RefinementCtx) => Promise<void>
Returns Zod.ZodEffects<Zod.ZodBigInt, bigint, bigint>
Inherited from ZodType.superRefine

transform

transform<NewOut>(
    transform: (
        arg: bigint,
        ctx: Zod.RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): Zod.ZodEffects<Zod.ZodBigInt, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: bigint, ctx: Zod.RefinementCtx) => NewOut | Promise<NewOut>
Returns Zod.ZodEffects<Zod.ZodBigInt, NewOut>
Inherited from ZodType.transform

Class ZodBigInt

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Zod.ZodBigInt

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

max

min

spa

Staticcreate

Accessors

description

Returns undefined | string

maxValue

Returns null | bigint

minValue

Returns null | bigint

Methods

_addCheck

Parameters

Returns Zod.ZodBigInt

_getOrReturnCtx

Parameters

Returns Zod.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.ParseReturnType<bigint>

_parseAsync

Parameters

Returns Zod.AsyncParseReturnType<bigint>

_parseSync

Parameters

Returns Zod.SyncParseReturnType<bigint>

_processInputParams

Parameters

Returns { ctx: Zod.ParseContext; status: Zod.ParseStatus }

_refinement

Parameters

Returns Zod.ZodEffects<Zod.ZodBigInt, bigint, bigint>

and

Type Parameters

Parameters

Returns Zod.ZodIntersection<Zod.ZodBigInt, T>

array

Returns Zod.ZodArray<Zod.ZodBigInt>

brand

Type Parameters

Parameters

Returns Zod.ZodBranded<Zod.ZodBigInt, B>

catch

Parameters

Returns Zod.ZodCatch<Zod.ZodBigInt>

Parameters

Returns Zod.ZodCatch<Zod.ZodBigInt>

default

Parameters

Returns Zod.ZodDefault<Zod.ZodBigInt>

Parameters

Returns Zod.ZodDefault<Zod.ZodBigInt>

describe

Parameters

Returns this

gt

Parameters

Returns Zod.ZodBigInt

gte

Parameters

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create