Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

useTransform.md

50 lines759 Bytes

1---
2id: useTransform
3title: useTransform
4---
5​
6# Function: useTransform()
7​
8```ts
9function useTransform<TFormData, TFormValidator>(fn, deps): object
10```
11​
12## Type Parameters
13​
14β€’ **TFormData**
15​
16β€’ **TFormValidator** *extends* `undefined` \| `Validator`\<`TFormData`, `unknown`\> = `undefined`
17​
18## Parameters
19​
20β€’ **fn**
21​
22β€’ **deps**: `unknown`[]
23​
24## Returns
25​
26`object`
27​
28### deps
29​
30```ts
31deps: unknown[];
32```
33​
34### fn()
35​
36```ts
37fn: (formBase) => FormApi<TFormData, TFormValidator>;
38```
39​
40#### Parameters
41​
42β€’ **formBase**: `FormApi`\<`any`, `any`\>
43​
44#### Returns
45​
46`FormApi`\<`TFormData`, `TFormValidator`\>
47​
48## Defined in
49​
50[useTransform.ts:3](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/react-form/src/useTransform.ts#L3)