MCPcopy Create free account
hub / github.com/TanStack/form / FieldApi

Class FieldApi

packages/form-core/src/FieldApi.ts:973–2039  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

971 * the `new FieldApi` constructor.
972 */
973export class FieldApi<
974 in out TParentData,
975 in out TName extends DeepKeys<TParentData>,
976 in out TData extends DeepValue<TParentData, TName>,
977 in out TOnMount extends
978 | undefined
979 | FieldValidateOrFn<TParentData, TName, TData>,
980 in out TOnChange extends
981 | undefined
982 | FieldValidateOrFn<TParentData, TName, TData>,
983 in out TOnChangeAsync extends
984 | undefined
985 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
986 in out TOnBlur extends
987 | undefined
988 | FieldValidateOrFn<TParentData, TName, TData>,
989 in out TOnBlurAsync extends
990 | undefined
991 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
992 in out TOnSubmit extends
993 | undefined
994 | FieldValidateOrFn<TParentData, TName, TData>,
995 in out TOnSubmitAsync extends
996 | undefined
997 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
998 in out TOnDynamic extends
999 | undefined
1000 | FieldValidateOrFn<TParentData, TName, TData>,
1001 in out TOnDynamicAsync extends
1002 | undefined
1003 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
1004 in out TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
1005 in out TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
1006 in out TFormOnChangeAsync extends
1007 | undefined
1008 | FormAsyncValidateOrFn<TParentData>,
1009 in out TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
1010 in out TFormOnBlurAsync extends
1011 | undefined
1012 | FormAsyncValidateOrFn<TParentData>,
1013 in out TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
1014 in out TFormOnSubmitAsync extends
1015 | undefined
1016 | FormAsyncValidateOrFn<TParentData>,
1017 in out TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
1018 in out TFormOnDynamicAsync extends
1019 | undefined
1020 | FormAsyncValidateOrFn<TParentData>,
1021 in out TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
1022 in out TParentSubmitMeta,
1023> {
1024 /**
1025 * A reference to the form API instance.
1026 */
1027 form: FieldApiOptions<
1028 TParentData,
1029 TName,
1030 TData,

Callers

nothing calls this directly

Calls 10

runValidatorMethod · 0.95
triggerOnBlurListenerMethod · 0.95
getByFunction · 0.90
mergeOptsFunction · 0.90
getSyncValidatorArrayFunction · 0.90
getAsyncValidatorArrayFunction · 0.90
updateMethod · 0.80
getErrorMapKeyFunction · 0.70
mountMethod · 0.45

Tested by

no test coverage detected