ObservableForm | @bytesoftio/form

Type parameters

TValue: object
TResult

Hierarchy

ObservableForm

Implemented by

Form

Index

Properties

Methods

Properties

changedFields

changedFields: ObservableFormFields

config

config: FormConfig<TValue, TResult>

dirtyFields

dirtyFields: ObservableFormFields

errors

errors: ObservableErrors

result

result: ObservableValue<TResult | undefined>

submitted

submitted: ObservableValue<boolean>

submitting

submitting: ObservableValue<boolean>

values

values: ObservableFormValues<TValue>

Methods

configure

configure(config: Partial<FormConfig<TValue, TResult>>): this

- Defined in types.ts:105
Parameters
- config: Partial<FormConfig<TValue, TResult>>
Returns this

deps

deps(field: string | string[], options?: DepsOptions): any[]

- Defined in types.ts:112
Parameters
- field: string | string[]
- Optional options: DepsOptions
Returns any[]

handler

handler(handler: FormHandler<TValue, TResult>): this

- Defined in types.ts:108
Parameters
- handler: FormHandler<TValue, TResult>
Returns this

listen

listen(callback: FormCallback<TValue, TResult>, notifyImmediately?: undefined | false | true): this

- Defined in types.ts:110
Parameters
- callback: FormCallback<TValue, TResult>
- Optional notifyImmediately: undefined | false | true
Returns this

reset

reset(initialValues?: TValue): void

- Defined in types.ts:101
Parameters
- Optional initialValues: TValue
Returns void

schema

schema(handler: ObjectSchema<TValue>): this

- Defined in types.ts:107
Parameters
- handler: ObjectSchema<TValue>
Returns this

submit

submit(options?: FormSubmitOptions): Promise<TResult | undefined>

- Defined in types.ts:102
Parameters
- Optional options: FormSubmitOptions
Returns Promise<TResult | undefined>

validate

validate(options?: FormValidateOptions): Promise<ValidationResult | undefined>

- Defined in types.ts:103
Parameters
- Optional options: FormValidateOptions
Returns Promise<ValidationResult | undefined>

validator

validator(handler: FormValidator<TValue, TResult>): this

- Defined in types.ts:106
Parameters
- handler: FormValidator<TValue, TResult>
Returns this