TerminalFieldBinding

interface

Public interface exported by @mwillbanks/tuil-form.

export interface TerminalFieldBinding<T> extends TerminalFieldState<T> {
  readonly setValue: (
    value: T,
    options?: { readonly validate?: boolean; readonly signal?: AbortSignal },
  ) => Promise<TerminalFieldState<T>>;
  readonly blur: (signal?: AbortSignal) => Promise<TerminalFieldState<T>>;
  readonly validate: (
    trigger?: ValidationTrigger,
    signal?: AbortSignal,
  ) => Promise<TerminalFieldState<T>>;
  readonly reset: (value?: T) => void;
  readonly serialize: (redactSecrets?: boolean) => T | "[REDACTED]";
  readonly subscribe: (observer: () => void) => () => void;
}

Members

Member	Type	Required	Description	Related types
`setValue`	`(value: T, options?: { readonly validate?: boolean; readonly signal?: AbortSignal; }) => Promise<TerminalFieldState<T>>`	Yes	The `setValue` member uses the `(value: T, options?: { readonly validate?: boolean; readonly signal?: AbortSignal; }) => Promise<TerminalFieldState<T>>` contract.	`TerminalFieldState`
`blur`	`(signal?: AbortSignal) => Promise<TerminalFieldState<T>>`	Yes	The `blur` member uses the `(signal?: AbortSignal) => Promise<TerminalFieldState<T>>` contract.	`TerminalFieldState`
`validate`	`(trigger?: ValidationTrigger, signal?: AbortSignal) => Promise<TerminalFieldState<T>>`	Yes	The `validate` member uses the `(trigger?: ValidationTrigger, signal?: AbortSignal) => Promise<TerminalFieldState<T>>` contract.	`TerminalFieldState`, `ValidationTrigger`
`reset`	`(value?: T) => void`	Yes	The `reset` member uses the `(value?: T) => void` contract.	—
`serialize`	`(redactSecrets?: boolean) => T \| "[REDACTED]"`	Yes	The `serialize` member uses the `(redactSecrets?: boolean) => T \| "[REDACTED]"` contract.	—
`subscribe`	`(observer: () => void) => () => void`	Yes	The `subscribe` member uses the `(observer: () => void) => () => void` contract.	—
`name`	`string`	Yes	The `name` member uses the `string` contract.	—
`value`	`T`	Yes	The `value` member uses the `T` contract.	—
`initialValue`	`T`	Yes	The `initialValue` member uses the `T` contract.	—
`errors`	`readonly string[]`	Yes	The `errors` member uses the `readonly string[]` contract.	—
`touched`	`boolean`	Yes	The `touched` member uses the `boolean` contract.	—
`dirty`	`boolean`	Yes	The `dirty` member uses the `boolean` contract.	—
`validating`	`boolean`	Yes	The `validating` member uses the `boolean` contract.	—
`disabled`	`boolean`	Yes	The `disabled` member uses the `boolean` contract.	—
`readOnly`	`boolean`	Yes	The `readOnly` member uses the `boolean` contract.	—
`valid`	`boolean`	Yes	The `valid` member uses the `boolean` contract.	—

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-form

TerminalFieldBinding

On this page