getInput

Retrieves the current input value of a specific field or the entire form. Returns a partial object as not all fields may have been set.

const input = getInput<TSchema>(form);
const input = getInput<TSchema, TFieldPath>(form, config);

Generics

• TSchema extends Schema
• TFieldPath extends RequiredPath | undefined = undefined

Parameters

• form BaseFormStore<TSchema>
• config GetFormInputConfig | GetFieldInputConfig<TSchema, RequiredPath> | undefined

Explanation

The form parameter is the form store to retrieve input from. The optional config parameter specifies which field to get input from - if omitted, returns input from the entire form.

Returns

• result PartialValues<v.InferInput<TSchema>>

Related

Primitives

• createForm

Methods

• setInput,
• reset