Class Completable<T>

Type Parameters

T extends ZodTypeAny

Hierarchy

ZodType<T["_output"], CompletableDef<T>, T["_input"]>
- Completable

Index

Constructors

constructor

new Completable<T extends ZodTypeAny>(def: CompletableDef): Completable<T>
Type Parameters
- T extends ZodTypeAny
Parameters
- def: CompletableDef
Returns Completable<T>
Inherited from ZodType< T["_output"], CompletableDef<T>, T["_input"] >.constructor
- Defined in node_modules/zod/lib/types.d.ts:79

Properties

`Readonly`_def

_def: CompletableDef

`Readonly`_input

_input: T["_input"]

`Readonly`_output

_output: T["_output"]

`Readonly`_type

_type: T["_output"]

~standard

"~standard": Props<T["_input"], T["_output"]>

spa

spa: (
data: unknown,
params?: Partial<ParseParams>,
) => Promise<SafeParseReturnType<T["_input"], T["_output"]>>

Alias of safeParseAsync

Accessors

description

get description(): string | undefined
Returns string | undefined
Inherited from ZodType.description
- Defined in node_modules/zod/lib/types.d.ts:53

Methods

_getOrReturnCtx

_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
Parameters
- input: ParseInput
- Optionalctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/zod/lib/types.d.ts:57

_getType

_getType(input: ParseInput): string
Parameters
- input: ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/zod/lib/types.d.ts:56

_parse

_parse(input: ParseInput): ParseReturnType<T["_output"]>
Parameters
- input: ParseInput
Returns ParseReturnType<T["_output"]>
Overrides ZodType._parse
- Defined in src/server/completable.ts:35

_parseAsync

_parseAsync(input: ParseInput): AsyncParseReturnType<T["_output"]>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<T["_output"]>
Inherited from ZodType._parseAsync
- Defined in node_modules/zod/lib/types.d.ts:63

_parseSync

_parseSync(input: ParseInput): SyncParseReturnType<T["_output"]>
Parameters
- input: ParseInput
Returns SyncParseReturnType<T["_output"]>
Inherited from ZodType._parseSync
- Defined in node_modules/zod/lib/types.d.ts:62

_processInputParams

_processInputParams(
input: ParseInput,
): { ctx: ParseContext; status: ParseStatus }
Parameters
- input: ParseInput
Returns { ctx: ParseContext; status: ParseStatus }
Inherited from ZodType._processInputParams
- Defined in node_modules/zod/lib/types.d.ts:58

_refinement

_refinement(
refinement: (arg: T["_output"], ctx: RefinementCtx) => any,
): ZodEffects<Completable<T>, T["_output"], T["_input"]>
Parameters
- refinement: (arg: T["_output"], ctx: RefinementCtx) => any
Returns ZodEffects<Completable<T>, T["_output"], T["_input"]>
Inherited from ZodType._refinement
- Defined in node_modules/zod/lib/types.d.ts:75

~validate

"~validate"(data: unknown): Result<T["_output"]> | Promise<Result<T["_output"]>>
Parameters
- data: unknown
Returns Result<T["_output"]> | Promise<Result<T["_output"]>>
Inherited from ZodType.~validate
- Defined in node_modules/zod/lib/types.d.ts:66

and

and<T extends ZodTypeAny>(incoming: T): ZodIntersection<Completable<T>, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- incoming: T
Returns ZodIntersection<Completable<T>, T>
Inherited from ZodType.and
- Defined in node_modules/zod/lib/types.d.ts:86

array

array(): ZodArray<Completable<T>>
Returns ZodArray<Completable<T>>
Inherited from ZodType.array
- Defined in node_modules/zod/lib/types.d.ts:83

brand

brand<B extends string | number | symbol>(
brand?: B,
): ZodBranded<Completable<T>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns ZodBranded<Completable<T>, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/lib/types.d.ts:90

catch

catch(def: T["_output"]): ZodCatch<Completable<T>>
Parameters
- def: T["_output"]
Returns ZodCatch<Completable<T>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:91
catch(
def: (ctx: { error: ZodError; input: T["_input"] }) => T["_output"],
): ZodCatch<Completable<T>>
Parameters
- def: (ctx: { error: ZodError; input: T["_input"] }) => T["_output"]
Returns ZodCatch<Completable<T>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:92

default

default(def: noUndefined<T["_input"]>): ZodDefault<Completable<T>>
Parameters
- def: noUndefined<T["_input"]>
Returns ZodDefault<Completable<T>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:88
default(def: () => noUndefined<T["_input"]>): ZodDefault<Completable<T>>
Parameters
- def: () => noUndefined<T["_input"]>
Returns ZodDefault<Completable<T>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:89

describe

describe(description: string): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe
- Defined in node_modules/zod/lib/types.d.ts:96

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable
- Defined in node_modules/zod/lib/types.d.ts:100

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional
- Defined in node_modules/zod/lib/types.d.ts:99

nullable

nullable(): ZodNullable<Completable<T>>
Returns ZodNullable<Completable<T>>
Inherited from ZodType.nullable
- Defined in node_modules/zod/lib/types.d.ts:81

nullish

nullish(): ZodOptional<ZodNullable<Completable<T>>>
Returns ZodOptional<ZodNullable<Completable<T>>>
Inherited from ZodType.nullish
- Defined in node_modules/zod/lib/types.d.ts:82

optional

optional(): ZodOptional<Completable<T>>
Returns ZodOptional<Completable<T>>
Inherited from ZodType.optional
- Defined in node_modules/zod/lib/types.d.ts:80

or

or<T extends ZodTypeAny>(option: T): ZodUnion<[Completable<T>, T]>
Type Parameters
- T extends ZodTypeAny
Parameters
- option: T
Returns ZodUnion<[Completable<T>, T]>
Inherited from ZodType.or
- Defined in node_modules/zod/lib/types.d.ts:85

parse

parse(data: unknown, params?: Partial<ParseParams>): T["_output"]
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns T["_output"]
Inherited from ZodType.parse
- Defined in node_modules/zod/lib/types.d.ts:64

parseAsync

parseAsync(data: unknown, params?: Partial<ParseParams>): Promise<T["_output"]>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns Promise<T["_output"]>
Inherited from ZodType.parseAsync
- Defined in node_modules/zod/lib/types.d.ts:67

pipe

pipe<T extends ZodTypeAny>(target: T): ZodPipeline<Completable<T>, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- target: T
Returns ZodPipeline<Completable<T>, T>
Inherited from ZodType.pipe
- Defined in node_modules/zod/lib/types.d.ts:97

promise

promise(): ZodPromise<Completable<T>>
Returns ZodPromise<Completable<T>>
Inherited from ZodType.promise
- Defined in node_modules/zod/lib/types.d.ts:84

readonly

readonly(): ZodReadonly<Completable<T>>
Returns ZodReadonly<Completable<T>>
Inherited from ZodType.readonly
- Defined in node_modules/zod/lib/types.d.ts:98

refine

refine<RefinedOutput extends any>(
    check: (arg: T["_output"]) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: T["_output"]) => CustomErrorParams),
): ZodEffects<Completable<T>, RefinedOutput, T["_input"]>
Type Parameters
- RefinedOutput extends any
Parameters
- check: (arg: T["_output"]) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: T["_output"]) => CustomErrorParams)
Returns ZodEffects<Completable<T>, RefinedOutput, T["_input"]>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:71
refine(
    check: (arg: T["_output"]) => unknown,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: T["_output"]) => CustomErrorParams),
): ZodEffects<Completable<T>, T["_output"], T["_input"]>
Parameters
- check: (arg: T["_output"]) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: T["_output"]) => CustomErrorParams)
Returns ZodEffects<Completable<T>, T["_output"], T["_input"]>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:72

refinement<RefinedOutput extends any>(
    check: (arg: T["_output"]) => arg is RefinedOutput,
    refinementData:
        | IssueData
        | ((arg: T["_output"], ctx: RefinementCtx) => IssueData),
): ZodEffects<Completable<T>, RefinedOutput, T["_input"]>
Type Parameters
- RefinedOutput extends any
Parameters
- check: (arg: T["_output"]) => arg is RefinedOutput
- refinementData: IssueData | ((arg: T["_output"], ctx: RefinementCtx) => IssueData)
Returns ZodEffects<Completable<T>, RefinedOutput, T["_input"]>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:73
refinement(
    check: (arg: T["_output"]) => boolean,
    refinementData:
        | IssueData
        | ((arg: T["_output"], ctx: RefinementCtx) => IssueData),
): ZodEffects<Completable<T>, T["_output"], T["_input"]>
Parameters
- check: (arg: T["_output"]) => boolean
- refinementData: IssueData | ((arg: T["_output"], ctx: RefinementCtx) => IssueData)
Returns ZodEffects<Completable<T>, T["_output"], T["_input"]>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:74

safeParse

safeParse(
data: unknown,
params?: Partial<ParseParams>,
): SafeParseReturnType<T["_input"], T["_output"]>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns SafeParseReturnType<T["_input"], T["_output"]>
Inherited from ZodType.safeParse
- Defined in node_modules/zod/lib/types.d.ts:65

safeParseAsync

safeParseAsync(
data: unknown,
params?: Partial<ParseParams>,
): Promise<SafeParseReturnType<T["_input"], T["_output"]>>
Parameters
- data: unknown
- Optionalparams: Partial<ParseParams>
Returns Promise<SafeParseReturnType<T["_input"], T["_output"]>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/zod/lib/types.d.ts:68

superRefine

superRefine<RefinedOutput extends any>(
    refinement: (
        arg: T["_output"],
        ctx: RefinementCtx,
    ) => arg is RefinedOutput,
): ZodEffects<Completable<T>, RefinedOutput, T["_input"]>
Type Parameters
- RefinedOutput extends any
Parameters
- refinement: (arg: T["_output"], ctx: RefinementCtx) => arg is RefinedOutput
Returns ZodEffects<Completable<T>, RefinedOutput, T["_input"]>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:76
superRefine(
refinement: (arg: T["_output"], ctx: RefinementCtx) => void,
): ZodEffects<Completable<T>, T["_output"], T["_input"]>
Parameters
- refinement: (arg: T["_output"], ctx: RefinementCtx) => void
Returns ZodEffects<Completable<T>, T["_output"], T["_input"]>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:77
superRefine(
refinement: (arg: T["_output"], ctx: RefinementCtx) => Promise<void>,
): ZodEffects<Completable<T>, T["_output"], T["_input"]>
Parameters
- refinement: (arg: T["_output"], ctx: RefinementCtx) => Promise<void>
Returns ZodEffects<Completable<T>, T["_output"], T["_input"]>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:78

transform

transform<NewOut>(
    transform: (
        arg: T["_output"],
        ctx: RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): ZodEffects<Completable<T>, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: T["_output"], ctx: RefinementCtx) => NewOut | Promise<NewOut>
Returns ZodEffects<Completable<T>, NewOut>
Inherited from ZodType.transform
- Defined in node_modules/zod/lib/types.d.ts:87

unwrap

unwrap(): T
Returns T
- Defined in src/server/completable.ts:45

`Static`create

create<T extends ZodTypeAny>(
    type: T,
    params: {
        description?: string;
        errorMap?: ZodErrorMap;
        invalid_type_error?: string;
        message?: string;
        required_error?: string;
    } & { complete: CompleteCallback<T> },
): Completable<T>
Type Parameters
- T extends ZodTypeAny
Parameters
- type: T
- params: {
      description?: string;
      errorMap?: ZodErrorMap;
      invalid_type_error?: string;
      message?: string;
      required_error?: string;
  } & { complete: CompleteCallback<T> }
Returns Completable<T>
- Defined in src/server/completable.ts:49

Class Completable<T>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Completable<T>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

~standard

spa

Accessors

description

Returns string | undefined

Methods

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns ParseReturnType<T["_output"]>

_parseAsync

Parameters

Returns AsyncParseReturnType<T["_output"]>

_parseSync

Parameters

Returns SyncParseReturnType<T["_output"]>

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus }

_refinement

Parameters

Returns ZodEffects<Completable<T>, T["_output"], T["_input"]>

~validate

Parameters

Returns Result<T["_output"]> | Promise<Result<T["_output"]>>

and

Type Parameters

Parameters

Returns ZodIntersection<Completable<T>, T>

array

Returns ZodArray<Completable<T>>

brand

Type Parameters

Parameters

Returns ZodBranded<Completable<T>, B>

catch

Parameters

Returns ZodCatch<Completable<T>>

Parameters

Returns ZodCatch<Completable<T>>

default

Parameters

Returns ZodDefault<Completable<T>>

Parameters

Returns ZodDefault<Completable<T>>

describe

Parameters

Returns this

isNullable

Returns boolean

isOptional

Returns boolean

nullable

Returns ZodNullable<Completable<T>>

nullish

Returns ZodOptional<ZodNullable<Completable<T>>>

optional

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create