FormConfigShared

^{ref / conversations / FormConfigShared}

A base options bag object for a form field. This holds all properties that are common among FormConfig and FormConfigWithReason.

^Source

Properties

next

next?: boolean;

Determines whether the outside middleware system should resume after the update is skipped in case that form validation fails.

Specify next: true to make sure that subsequent handlers will run. This effectively causes next to be called by the plugin.

Defaults to false unless the conversation is marked as parallel, in which case this option defaults to true.

^Source

maxMilliseconds

maxMilliseconds?: number;

Specifies a timeout for the wait call.

When the form field is reached, Date.now() is called. When the form field resolves, Date.now() is called again, and the two values are compared. If the form field resolved more than the specified number of milliseconds after it was reached initially, then the conversation will be halted, any exit handlers will be called, and the surrounding middleware will resume normally so that subsequent handlers can run.

To the outside middleware system, this will look like the conversation was never active.

^Source

collationKey

collationKey?: string;

Collation key for the wait call, safety measure to protect against data corruption. This is used extensively by the plugin internally, but it is rarely useful to changes this behavior.

^Source

action

action?: FormAction<C, T>;

A form action to perform on the context object after the form validation succeeds for a context object, and before the respective value is returned form the form field.

^Source