Skip to main content
Version: 0.1.2

Interface: FormHandle()

Imported from @react-logic/utils

Defined in: utils/src/lib/forms.ts:213

Callable form-state signal. Read with (), mutate via setValue / setError / reset. The useForm hook reads the underlying tree for its bind/error proxies.

Type Parameters​

S​

S extends Schema

The schema.

FormHandle(): FormSnapshot<S>

Defined in: utils/src/lib/forms.ts:214

Callable form-state signal. Read with (), mutate via setValue / setError / reset. The useForm hook reads the underlying tree for its bind/error proxies.

Returns​

FormSnapshot<S>

Properties​

[REACTIVE_ACCESSOR_MARKER]​

[REACTIVE_ACCESSOR_MARKER]: true

Defined in: utils/src/lib/forms.ts:226

Methods​

reset()​

reset(): void

Defined in: utils/src/lib/forms.ts:217

Returns​

void

setError()​

setError(path, error): void

Defined in: utils/src/lib/forms.ts:216

Parameters​

path​

string

error​

string | null

Returns​

void

setValue()​

setValue(path, value): void

Defined in: utils/src/lib/forms.ts:215

Parameters​

path​

string

value​

unknown

Returns​

void