Hero Hook Form API v2.5.1

Hero Hook Form API / FormTestUtils

Interface: FormTestUtils<TFieldValues>

Defined in: types.ts:356 

Type Parameters

TFieldValues

TFieldValues extends FieldValues

Properties

getField()

getField: (name) => object

Defined in: types.ts:357 

Parameters

name

Path<TFieldValues>

Returns

object

value

value: unknown

error

error: unknown

isDirty

isDirty: boolean

isTouched

isTouched: boolean

submitForm()

submitForm: () => Promise<void>

Defined in: types.ts:363 

Returns

Promise<void>

resetForm()

resetForm: () => void

Defined in: types.ts:364 

Returns

void

getFormState()

getFormState: () => object

Defined in: types.ts:365 

Returns

object

values

values: TFieldValues

errors

errors: FieldErrors<TFieldValues>

isSubmitting

isSubmitting: boolean

isSubmitted

isSubmitted: boolean

isSuccess

isSuccess: boolean

setFieldValue()

setFieldValue: (name, value) => void

Defined in: types.ts:372 

Parameters

name

Path<TFieldValues>

value

unknown

Returns

void

triggerValidation()

triggerValidation: (name?) => Promise<boolean>

Defined in: types.ts:373 

Parameters

name?

Path<TFieldValues>

Returns

Promise<boolean>