API Reference / @gtkx/forms / UseFieldArrayReturn

Type Alias: UseFieldArrayReturn<TFieldValues, TFieldArrayName, TKeyName>

UseFieldArrayReturn<TFieldValues, TFieldArrayName, TKeyName> = object

Defined in: node_modules/.pnpm/react-hook-form@7.87.0_react@19.2.8/node_modules/react-hook-form/dist/types/fieldArray.d.ts:185

Type Parameters

TFieldValues

TFieldValues extends FieldValues = FieldValues

TFieldArrayName

TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>

TKeyName

TKeyName extends string = "id"

Properties

append

append: UseFieldArrayAppend<TFieldValues, TFieldArrayName>

Defined in: node_modules/.pnpm/react-hook-form@7.87.0_react@19.2.8/node_modules/react-hook-form/dist/types/fieldArray.d.ts:189

---

fields

fields: FieldArrayWithId<TFieldValues, TFieldArrayName, TKeyName> & object[]

Defined in: node_modules/.pnpm/react-hook-form@7.87.0_react@19.2.8/node_modules/react-hook-form/dist/types/fieldArray.d.ts:194

---

insert

insert: UseFieldArrayInsert<TFieldValues, TFieldArrayName>

Defined in: node_modules/.pnpm/react-hook-form@7.87.0_react@19.2.8/node_modules/react-hook-form/dist/types/fieldArray.d.ts:191

---

move

move: UseFieldArrayMove

Defined in: node_modules/.pnpm/react-hook-form@7.87.0_react@19.2.8/node_modules/react-hook-form/dist/types/fieldArray.d.ts:187

---

prepend

prepend: UseFieldArrayPrepend<TFieldValues, TFieldArrayName>

Defined in: node_modules/.pnpm/react-hook-form@7.87.0_react@19.2.8/node_modules/react-hook-form/dist/types/fieldArray.d.ts:188

---

remove

remove: UseFieldArrayRemove

Defined in: node_modules/.pnpm/react-hook-form@7.87.0_react@19.2.8/node_modules/react-hook-form/dist/types/fieldArray.d.ts:190

---

replace

replace: UseFieldArrayReplace<TFieldValues, TFieldArrayName>

Defined in: node_modules/.pnpm/react-hook-form@7.87.0_react@19.2.8/node_modules/react-hook-form/dist/types/fieldArray.d.ts:193

---

swap

swap: UseFieldArraySwap

Defined in: node_modules/.pnpm/react-hook-form@7.87.0_react@19.2.8/node_modules/react-hook-form/dist/types/fieldArray.d.ts:186

---

update

update: UseFieldArrayUpdate<TFieldValues, TFieldArrayName>

Defined in: node_modules/.pnpm/react-hook-form@7.87.0_react@19.2.8/node_modules/react-hook-form/dist/types/fieldArray.d.ts:192