Class MobxZodBox<T, Output, Input>

Type Parameters

T extends ZodTypeAny
Output = output<T>
Input = input<T>

Hierarchy

ZodType<Output, MobxZodBoxDef<T>, Input>
- MobxZodBox

Index

Constructors

constructor

new MobxZodBox<T, Output, Input>(def): MobxZodBox<T, Output, Input>
Type Parameters
- T extends ZodTypeAny
- Output = output<T>
- Input = input<T>
Parameters
- def: MobxZodBoxDef<T>
Returns MobxZodBox<T, Output, Input>
Inherited from ZodType<Output, MobxZodBoxDef<T>, Input>.constructor
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:76

Properties

`Readonly` _def

_def: MobxZodBoxDef<T>

_formMeta

_formMeta: FormMeta

`Readonly` _input

_input: Input

`Readonly` _output

_output: Output

`Readonly` _type

_type: Output

spa

spa: ((data, params?) => Promise<SafeParseReturnType<Input, Output>>)

Alias of safeParseAsync

Type declaration

- (data, params?): Promise<SafeParseReturnType<Input, Output>>
- Parameters
  - data: unknown
  - Optional params: Partial<ParseParams>
  Returns Promise<SafeParseReturnType<Input, Output>>

Accessors

description

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

Methods

_getOrReturnCtx

_getOrReturnCtx(input, ctx?): ParseContext
Parameters
- input: ParseInput
- Optional ctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:55

_getType

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

_parse

_parse(input): ParseReturnType<Output>
Parameters
- input: ParseInput
Returns ParseReturnType<Output>
Overrides ZodType._parse
- Defined in packages/mobx-zod-form/src/zod-extra.ts:189

_parseAsync

_parseAsync(input): AsyncParseReturnType<Output>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<Output>
Inherited from ZodType._parseAsync
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:61

_parseSync

_parseSync(input): SyncParseReturnType<Output>
Parameters
- input: ParseInput
Returns SyncParseReturnType<Output>
Inherited from ZodType._parseSync
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:60

_processInputParams

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

_refinement

_refinement(refinement): ZodEffects<MobxZodBox<T, Output, Input>, Output, Input>
Parameters
- refinement: ((arg, ctx) => any)
  - - (arg, ctx): any
    - Parameters
      arg: Output
      ctx: RefinementCtx
      Returns any
Returns ZodEffects<MobxZodBox<T, Output, Input>, Output, Input>
Inherited from ZodType._refinement
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:72

and

and<T>(incoming): ZodIntersection<MobxZodBox<T, Output, Input>, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- incoming: T
Returns ZodIntersection<MobxZodBox<T, Output, Input>, T>
Inherited from ZodType.and
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:83

array

array(): ZodArray<MobxZodBox<T, Output, Input>, "many">
Returns ZodArray<MobxZodBox<T, Output, Input>, "many">
Inherited from ZodType.array
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:80

box

box(): MobxZodBox<MobxZodBox<T, Output, Input>, Output, Input>
A wrapping type that parses as-is like its inner type, but forbids mobx-zod-form from creating fields or encoding/decoding for inner fields. In other words, the inner value will be treated as if it is an atomic value.

This means you can deal with the object with your custom logics.

Returns MobxZodBox<MobxZodBox<T, Output, Input>, Output, Input>
Inherited from ZodType.box
- Defined in packages/mobx-zod-form/src/zod-extra.ts:55

brand

brand<B>(brand?): ZodBranded<MobxZodBox<T, Output, Input>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optional brand: B
Returns ZodBranded<MobxZodBox<T, Output, Input>, B>
Inherited from ZodType.brand
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:87

catch

catch(def): ZodCatch<MobxZodBox<T, Output, Input>>
Parameters
- def: Output
Returns ZodCatch<MobxZodBox<T, Output, Input>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:88
catch(def): ZodCatch<MobxZodBox<T, Output, Input>>
Parameters
- def: ((ctx) => Output)
  - - (ctx): Output
    - Parameters
      ctx: {
      error: ZodError<any>;
      input: Input;
      }
      error: ZodError<any>
      input: Input
      Returns Output
Returns ZodCatch<MobxZodBox<T, Output, Input>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:89

default

default(def): ZodDefault<MobxZodBox<T, Output, Input>>
Parameters
- def: noUndefined<Input>
Returns ZodDefault<MobxZodBox<T, Output, Input>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:85
default(def): ZodDefault<MobxZodBox<T, Output, Input>>
Parameters
- def: (() => noUndefined<Input>)
  - - (): noUndefined<Input>
    - Returns noUndefined<Input>
Returns ZodDefault<MobxZodBox<T, Output, Input>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:86

describe

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

formMeta

formMeta<T, Z>(this, meta): Z
Extend the form meta of the type. You can retrieve it later with getFormMeta. Sorry we cannot better type the returning type, which means you'll get optional properties when you use them, because zod does not give us a chance to use generic here.
Type Parameters
- T extends Partial<FormMeta>
- Z extends ZodTypeAny
Parameters
- this: Z
  type
- meta: T
  custom partial form meta
Returns Z
Inherited from ZodType.formMeta
- Defined in packages/mobx-zod-form/src/zod-extra.ts:41

getFormMeta

getFormMeta(): FormMeta
Returns FormMeta
Inherited from ZodType.getFormMeta
- Defined in packages/mobx-zod-form/src/zod-extra.ts:46

innerType

innerType(): T
Returns T
- Defined in packages/mobx-zod-form/src/zod-extra.ts:193

isNullable

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

isOptional

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

label

label<Z>(this, label): Z
Shorthand for .formMeta({ label })
Type Parameters
- Z extends ZodTypeAny
Parameters
- this: Z
- label: string
Returns Z
Inherited from ZodType.label
- Defined in packages/mobx-zod-form/src/zod-extra.ts:60

nullable

nullable(): ZodNullable<MobxZodBox<T, Output, Input>>
Returns ZodNullable<MobxZodBox<T, Output, Input>>
Inherited from ZodType.nullable
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:78

nullish

nullish(): ZodOptional<ZodNullable<MobxZodBox<T, Output, Input>>>
Returns ZodOptional<ZodNullable<MobxZodBox<T, Output, Input>>>
Inherited from ZodType.nullish
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:79

optional

optional(): ZodOptional<MobxZodBox<T, Output, Input>>
Returns ZodOptional<MobxZodBox<T, Output, Input>>
Inherited from ZodType.optional
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:77

or

or<T>(option): ZodUnion<[MobxZodBox<T, Output, Input>, T]>
Type Parameters
- T extends ZodTypeAny
Parameters
- option: T
Returns ZodUnion<[MobxZodBox<T, Output, Input>, T]>
Inherited from ZodType.or
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:82

parse

parse(data, params?): Output
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Output
Inherited from ZodType.parse
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:62

parseAsync

parseAsync(data, params?): Promise<Output>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<Output>
Inherited from ZodType.parseAsync
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:64

pipe

pipe<T>(target): ZodPipeline<MobxZodBox<T, Output, Input>, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- target: T
Returns ZodPipeline<MobxZodBox<T, Output, Input>, T>
Inherited from ZodType.pipe
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:94

promise

promise(): ZodPromise<MobxZodBox<T, Output, Input>>
Returns ZodPromise<MobxZodBox<T, Output, Input>>
Inherited from ZodType.promise
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:81

readonly

readonly(): ZodReadonly<MobxZodBox<T, Output, Input>>
Returns ZodReadonly<MobxZodBox<T, Output, Input>>
Inherited from ZodType.readonly
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:95

refine

refine<RefinedOutput>(check, message?): ZodEffects<MobxZodBox<T, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- check: ((arg) => arg is RefinedOutput)
  - - (arg): arg is RefinedOutput
    - Parameters
      arg: Output
      Returns arg is RefinedOutput
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
Returns ZodEffects<MobxZodBox<T, Output, Input>, RefinedOutput, Input>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:68
refine(check, message?): ZodEffects<MobxZodBox<T, Output, Input>, Output, Input>
Parameters
- check: ((arg) => unknown)
  - - (arg): unknown
    - Parameters
      arg: Output
      Returns unknown
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
Returns ZodEffects<MobxZodBox<T, Output, Input>, Output, Input>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:69

refinement

refinement<RefinedOutput>(check, refinementData): ZodEffects<MobxZodBox<T, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- check: ((arg) => arg is RefinedOutput)
  - - (arg): arg is RefinedOutput
    - Parameters
      arg: Output
      Returns arg is RefinedOutput
- refinementData: IssueData | ((arg, ctx) => IssueData)
Returns ZodEffects<MobxZodBox<T, Output, Input>, RefinedOutput, Input>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:70
refinement(check, refinementData): ZodEffects<MobxZodBox<T, Output, Input>, Output, Input>
Parameters
- check: ((arg) => boolean)
  - - (arg): boolean
    - Parameters
      arg: Output
      Returns boolean
- refinementData: IssueData | ((arg, ctx) => IssueData)
Returns ZodEffects<MobxZodBox<T, Output, Input>, Output, Input>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:71

safeParse

safeParse(data, params?): SafeParseReturnType<Input, Output>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns SafeParseReturnType<Input, Output>
Inherited from ZodType.safeParse
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:63

safeParseAsync

safeParseAsync(data, params?): Promise<SafeParseReturnType<Input, Output>>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<SafeParseReturnType<Input, Output>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:65

superRefine

superRefine<RefinedOutput>(refinement): ZodEffects<MobxZodBox<T, Output, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- refinement: ((arg, ctx) => arg is RefinedOutput)
  - - (arg, ctx): arg is RefinedOutput
    - Parameters
      arg: Output
      ctx: RefinementCtx
      Returns arg is RefinedOutput
Returns ZodEffects<MobxZodBox<T, Output, Input>, RefinedOutput, Input>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:73
superRefine(refinement): ZodEffects<MobxZodBox<T, Output, Input>, Output, Input>
Parameters
- refinement: ((arg, ctx) => void)
  - - (arg, ctx): void
    - Parameters
      arg: Output
      ctx: RefinementCtx
      Returns void
Returns ZodEffects<MobxZodBox<T, Output, Input>, Output, Input>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:74
superRefine(refinement): ZodEffects<MobxZodBox<T, Output, Input>, Output, Input>
Parameters
- refinement: ((arg, ctx) => Promise<void>)
  - - (arg, ctx): Promise<void>
    - Parameters
      arg: Output
      ctx: RefinementCtx
      Returns Promise<void>
Returns ZodEffects<MobxZodBox<T, Output, Input>, Output, Input>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:75

transform

transform<NewOut>(transform): ZodEffects<MobxZodBox<T, Output, Input>, NewOut, Input>
Type Parameters
- NewOut
Parameters
- transform: ((arg, ctx) => NewOut | Promise<NewOut>)
  - - (arg, ctx): NewOut | Promise<NewOut>
    - Parameters
      arg: Output
      ctx: RefinementCtx
      Returns NewOut | Promise<NewOut>
Returns ZodEffects<MobxZodBox<T, Output, Input>, NewOut, Input>
Inherited from ZodType.transform
- Defined in node_modules/.pnpm/zod@3.23.8/node_modules/zod/lib/types.d.ts:84

`Static` create

create<I>(schema): MobxZodBox<I, output<I>, input<I>>
Type Parameters
- I extends ZodTypeAny
Parameters
- schema: I
Returns MobxZodBox<I, output<I>, input<I>>
- Defined in packages/mobx-zod-form/src/zod-extra.ts:197

Class MobxZodBox<T, Output, Input>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MobxZodBox<T, Output, Input>

Properties

Readonly _def

_formMeta

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

Returns Promise<SafeParseReturnType<Input, Output>>

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns ParseReturnType<Output>

_parseAsync

Parameters

Returns AsyncParseReturnType<Output>

_parseSync

Parameters

Returns SyncParseReturnType<Output>

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

Parameters

Returns any

Returns ZodEffects<MobxZodBox<T, Output, Input>, Output, Input>

and

Type Parameters

Parameters

Returns ZodIntersection<MobxZodBox<T, Output, Input>, T>

array

Returns ZodArray<MobxZodBox<T, Output, Input>, "many">

box

Returns MobxZodBox<MobxZodBox<T, Output, Input>, Output, Input>

brand

Type Parameters

Parameters

Returns ZodBranded<MobxZodBox<T, Output, Input>, B>

catch

Parameters

Returns ZodCatch<MobxZodBox<T, Output, Input>>

Parameters

Parameters

error: ZodError<any>

input: Input

Returns Output

Returns ZodCatch<MobxZodBox<T, Output, Input>>

default

Parameters

Returns ZodDefault<MobxZodBox<T, Output, Input>>

Parameters

Returns noUndefined<Input>

Returns ZodDefault<MobxZodBox<T, Output, Input>>

describe

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

Returns {
ctx: ParseContext;
status: ParseStatus;
}