Class MobxZodForm<T>

Type Parameters

T extends MobxZodTypes

Hierarchy

MobxZodForm

Constructors

constructor

new MobxZodForm<T>(schema: T, _options?: MobxZodFormOptions<T>): MobxZodForm<T>
Type Parameters
- T extends MobxZodTypes
Parameters
- schema: T
- _options: MobxZodFormOptions<T> = {}
Returns MobxZodForm<T>
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:87

Properties

_curFieldUniqueId

_curFieldUniqueId: number = 0

`Optional` _currentSetActionOptions

_currentSetActionOptions?: SetActionOptions

_isDirty

_isDirty: boolean = false

_isSubmitting

_isSubmitting: boolean = false

`Readonly` _options

_options: MobxZodFormOptions<T> = {}

`Optional` _parsed

_parsed?: SafeParseReturnType<T["_input"], T["_output"]>

_rawInput

_rawInput: unknown

_submitCount

_submitCount: number = 0

_validationTasks

_validationTasks: ValidationTask[] = []

element

element: null | HTMLFormElement = null

id

id: string

root

root: MapZodTypeToField<T>

`Readonly` schema

schema: T

schemaFormMeta

schemaFormMeta: FormMeta

Accessors

input

get input(): SafeDecodeResult<unknown, T["_input"]>
Returns SafeDecodeResult<unknown, T["_input"]>
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:224

isDirty

get isDirty(): boolean
Returns boolean
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:212

isSubmitting

get isSubmitting(): boolean
Returns boolean
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:220

looseInput

get looseInput(): SafeDecodeResult<unknown, unknown>
Returns SafeDecodeResult<unknown, unknown>
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:228

options

get options(): {
    initialOutput: any;
    plugins: MobxZodPlugin[];
    setActionOptions: {
        validateSync: boolean;
    };
    shouldFocusError: false | "first-y" | "first-x";
    validateOnMount: boolean;
}
Returns {
    initialOutput: any;
    plugins: MobxZodPlugin[];
    setActionOptions: {
        validateSync: boolean;
    };
    shouldFocusError: false | "first-y" | "first-x";
    validateOnMount: boolean;
}
- initialOutput: any
- plugins: MobxZodPlugin[]
- setActionOptions: {
  validateSync: boolean;
  }
  - validateSync: boolean
- shouldFocusError: false | "first-y" | "first-x"
- validateOnMount: boolean
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:193

parsed

get parsed(): SafeParseReturnType<T["_input"], T["_output"]>
Returns SafeParseReturnType<T["_input"], T["_output"]>
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:232

rawInput

get rawInput(): unknown
Returns unknown
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:208

submitCount

get submitCount(): number
Returns number
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:216

Methods

_getRawInputAt

_getRawInputAt(path: ParsePath): unknown
Parameters
- path: ParsePath
Returns unknown
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:244

_notifyChange

_notifyChange(): void
Returns void
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:260

_setRawInputAt

_setRawInputAt(path: ParsePath, value: unknown): void
Parameters
- path: ParsePath
- value: unknown
Returns void
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:249

flushValidationTasks

flushValidationTasks(): void
Returns void
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:127

focusError

focusError(): void
Returns void
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:369

getFieldUniqueId

getFieldUniqueId(): string
Returns string
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:123

handleSubmit

handleSubmit(onSubmit: (() => void | Promise<void>)): Promise<void>
Parameters
- onSubmit: (() => void | Promise<void>)
  - - (): void | Promise<void>
    - Returns void | Promise<void>
Returns Promise<void>
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:326

resolveCurrentSetActionOptions

resolveCurrentSetActionOptions(): SetActionOptions
Returns SetActionOptions
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:322

start

start(): (() => void)
Returns (() => void)
- - (): void
  - Returns void
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:176

startValidationWorker

startValidationWorker(): (() => void)
Returns (() => void)
- - (): void
  - Returns void
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:139

validate

validate(): void
Parse the input with the root schema, then compare the new issues with old issues. Only assign new errors to corresponding fields, so that those unrelated fields are untouched. Errors are compared against their error messages.

Returns void
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:277

withSetActionOptions

withSetActionOptions(options: InputSetActionOptions, action: (() => void)): void
Parameters
- options: InputSetActionOptions
- action: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in packages/mobx-zod-form/src/MobxZodForm.ts:311

Generated using TypeDoc