Interface FormMeta

Metadata associated with the Zod type definition. You can extend the interface to add whatever information you need. Notice for label, description, mobx-zod-form itself doesn't use them, but you may build your UI based on them.

Hierarchy

  • FormMeta

Properties

decode description? encode getInitialOutput label? safeDecode

Properties

decode

decode: ((input: any) => any)

Type declaration

    • (input: any): any
    • Internal

      Returns

      Parameters

      • input: any

      Returns any

Optional description

description?: string

The description associated with the field

encode

encode: ((output: unknown) => any)

Type declaration

    • (output: unknown): any
    • Internal

      Returns

      Parameters

      • output: unknown

      Returns any

getInitialOutput

getInitialOutput: (() => any)

Type declaration

    • (): any

    • The initial output for this field. By default, a reasonable default value is given.

      See

      TODO: explain initialOutput

      Returns

      Get the initial output.

      Returns any

Optional label

label?: string

The label associated with the field.

safeDecode

safeDecode: ((input: unknown, passthrough?: boolean) => SafeDecodeResult<unknown, any>)

Type declaration

    • (input: unknown, passthrough?: boolean): SafeDecodeResult<unknown, any>
    • Internal

      Returns

      Parameters

      • input: unknown
      • Optional passthrough: boolean

      Returns SafeDecodeResult<unknown, any>

Settings

Member Visibility

Theme

Generated using TypeDoc