docs: Update typedoc (#865)

Author: lachlancollins

docs/framework/angular/reference/injectform.md

@@ -4,7 +4,7 @@
 function injectForm<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormValidator>
 ```
 
-## Type parameters
+## Type Parameters
 
 • **TFormData**
 
@@ -18,6 +18,6 @@ function injectForm<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormV
 
 `FormApi`\<`TFormData`, `TFormValidator`\>
 
-## Source
+## Defined in
 
-[inject-form.ts:4](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/inject-form.ts#L4)
+[inject-form.ts:4](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/inject-form.ts#L4)

docs/framework/angular/reference/injectstore.md

@@ -4,7 +4,7 @@
 function injectStore<TFormData, TFormValidator, TSelected>(form, selector?): Signal<TSelected>
 ```
 
-## Type parameters
+## Type Parameters
 
 • **TFormData**
 
@@ -22,6 +22,6 @@ function injectStore<TFormData, TFormValidator, TSelected>(form, selector?): Sig
 
 `Signal`\<`TSelected`\>
 
-## Source
+## Defined in
 
-[inject-store.ts:4](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/inject-store.ts#L4)
+[inject-store.ts:4](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/inject-store.ts#L4)

docs/framework/angular/reference/tanstackfield.md

@@ -1,6 +1,6 @@
 # Class: TanStackField\<TParentData, TName, TFieldValidator, TFormValidator, TData\>
 
-## Type parameters
+## Type Parameters
 
 • **TParentData**
 
@@ -39,9 +39,9 @@ new TanStackField<TParentData, TName, TFieldValidator, TFormValidator, TData>():
 api: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;
 ```
 
-#### Source
+#### Defined in
 
-[tanstack-field.directive.ts:61](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/tanstack-field.directive.ts#L61)
+[tanstack-field.directive.ts:61](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L61)
 
 ***
 
@@ -51,13 +51,15 @@ api: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;
 optional asyncAlways: boolean;
 ```
 
+If `true`, always run async validation, even if there are errors emitted during synchronous validation.
+
 #### Implementation of
 
 `FieldOptions.asyncAlways`
 
-#### Source
+#### Defined in
 
-[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/tanstack-field.directive.ts#L50)
+[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L50)
 
 ***
 
@@ -67,13 +69,15 @@ optional asyncAlways: boolean;
 optional asyncDebounceMs: number;
 ```
 
+The default time to debounce async validation if there is not a more specific debounce time passed.
+
 #### Implementation of
 
 `FieldOptions.asyncDebounceMs`
 
-#### Source
+#### Defined in
 
-[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/tanstack-field.directive.ts#L49)
+[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L49)
 
 ***
 
@@ -83,13 +87,15 @@ optional asyncDebounceMs: number;
 optional defaultMeta: Partial<FieldMeta>;
 ```
 
+An optional object with default metadata for the field.
+
 #### Implementation of
 
 `FieldOptions.defaultMeta`
 
-#### Source
+#### Defined in
 
-[tanstack-field.directive.ts:59](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/tanstack-field.directive.ts#L59)
+[tanstack-field.directive.ts:59](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L59)
 
 ***
 
@@ -99,13 +105,15 @@ optional defaultMeta: Partial<FieldMeta>;
 optional defaultValue: NoInfer<TData>;
 ```
 
+An optional default value for the field.
+
 #### Implementation of
 
 `FieldOptions.defaultValue`
 
-#### Source
+#### Defined in
 
-[tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/tanstack-field.directive.ts#L48)
+[tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L48)
 
 ***
 
@@ -115,13 +123,15 @@ optional defaultValue: NoInfer<TData>;
 name: TName;
 ```
 
+The field name. The type will be `DeepKeys<TParentData>` to ensure your name is a deep key of the parent dataset.
+
 #### Implementation of
 
 `FieldOptions.name`
 
-#### Source
+#### Defined in
 
-[tanstack-field.directive.ts:44](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/tanstack-field.directive.ts#L44)
+[tanstack-field.directive.ts:44](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L44)
 
 ***
 
@@ -131,9 +141,9 @@ name: TName;
 tanstackField: FormApi<TParentData, TFormValidator>;
 ```
 
-#### Source
+#### Defined in
 
-[tanstack-field.directive.ts:52](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/tanstack-field.directive.ts#L52)
+[tanstack-field.directive.ts:52](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L52)
 
 ***
 
@@ -147,9 +157,9 @@ optional unmount: () => void;
 
 `void`
 
-#### Source
+#### Defined in
 
-[tanstack-field.directive.ts:76](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/tanstack-field.directive.ts#L76)
+[tanstack-field.directive.ts:76](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L76)
 
 ***
 
@@ -159,13 +169,15 @@ optional unmount: () => void;
 optional validatorAdapter: TFieldValidator;
 ```
 
+A validator provided by an extension, like `yupValidator` from `@tanstack/yup-form-adapter`
+
 #### Implementation of
 
 `FieldOptions.validatorAdapter`
 
-#### Source
+#### Defined in
 
-[tanstack-field.directive.ts:51](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/tanstack-field.directive.ts#L51)
+[tanstack-field.directive.ts:51](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L51)
 
 ***
 
@@ -175,13 +187,15 @@ optional validatorAdapter: TFieldValidator;
 optional validators: NoInfer<FieldValidators<TParentData, TName, TFieldValidator, TFormValidator, TData>>;
 ```
 
+A list of validators to pass to the field
+
 #### Implementation of
 
 `FieldOptions.validators`
 
-#### Source
+#### Defined in
 
-[tanstack-field.directive.ts:56](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/tanstack-field.directive.ts#L56)
+[tanstack-field.directive.ts:56](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L56)
 
 ## Methods
 
@@ -191,6 +205,11 @@ optional validators: NoInfer<FieldValidators<TParentData, TName, TFieldValidator
 ngOnChanges(): void
 ```
 
+A callback method that is invoked immediately after the
+default change detector has checked data-bound properties
+if at least one has changed, and before the view and content
+children are checked.
+
 #### Returns
 
 `void`
@@ -199,9 +218,9 @@ ngOnChanges(): void
 
 `OnChanges.ngOnChanges`
 
-#### Source
+#### Defined in
 
-[tanstack-field.directive.ts:88](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/tanstack-field.directive.ts#L88)
+[tanstack-field.directive.ts:88](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L88)
 
 ***
 
@@ -211,6 +230,9 @@ ngOnChanges(): void
 ngOnDestroy(): void
 ```
 
+A callback method that performs custom clean-up, invoked immediately
+before a directive, pipe, or service instance is destroyed.
+
 #### Returns
 
 `void`
@@ -219,9 +241,9 @@ ngOnDestroy(): void
 
 `OnDestroy.ngOnDestroy`
 
-#### Source
+#### Defined in
 
-[tanstack-field.directive.ts:84](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/tanstack-field.directive.ts#L84)
+[tanstack-field.directive.ts:84](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L84)
 
 ***
 
@@ -231,6 +253,12 @@ ngOnDestroy(): void
 ngOnInit(): void
 ```
 
+A callback method that is invoked immediately after the
+default change detector has checked the directive's
+data-bound properties for the first time,
+and before any of the view or content children have been checked.
+It is invoked only once when the directive is instantiated.
+
 #### Returns
 
 `void`
@@ -239,6 +267,6 @@ ngOnInit(): void
 
 `OnInit.ngOnInit`
 
-#### Source
+#### Defined in
 
-[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/angular-form/src/tanstack-field.directive.ts#L78)
+[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/angular-form/src/tanstack-field.directive.ts#L78)

docs/framework/lit/reference/tanstackformcontroller.md

@@ -1,6 +1,6 @@
 # Class: TanStackFormController\<TParentData, TFormValidator\>
 
-## Type parameters
+## Type Parameters
 
 • **TParentData**
 
@@ -28,9 +28,9 @@ new TanStackFormController<TParentData, TFormValidator>(host, config?): TanStack
 
 [`TanStackFormController`](tanstackformcontroller.md)\<`TParentData`, `TFormValidator`\>
 
-#### Source
+#### Defined in
 
-[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/lit-form/src/tanstack-form-controller.ts#L93)
+[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/lit-form/src/tanstack-form-controller.ts#L93)
 
 ## Properties
 
@@ -40,9 +40,9 @@ new TanStackFormController<TParentData, TFormValidator>(host, config?): TanStack
 api: FormApi<TParentData, TFormValidator>;
 ```
 
-#### Source
+#### Defined in
 
-[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/lit-form/src/tanstack-form-controller.ts#L91)
+[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/lit-form/src/tanstack-form-controller.ts#L91)
 
 ## Methods
 
@@ -52,7 +52,7 @@ api: FormApi<TParentData, TFormValidator>;
 field<TName, TFieldValidator, TData>(fieldConfig, render): object
 ```
 
-#### Type parameters
+#### Type Parameters
 
 • **TName** *extends* `string` \| `number`
 
@@ -94,9 +94,9 @@ options: FieldOptions<TParentData, TName, TFieldValidator, TFormValidator, TData
 render: renderCallback<TParentData, TName, TFieldValidator, TFormValidator, TData>;
 ```
 
-#### Source
+#### Defined in
 
-[tanstack-form-controller.ts:112](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/lit-form/src/tanstack-form-controller.ts#L112)
+[tanstack-form-controller.ts:112](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/lit-form/src/tanstack-form-controller.ts#L112)
 
 ***
 
@@ -106,6 +106,10 @@ render: renderCallback<TParentData, TName, TFieldValidator, TFormValidator, TDat
 hostConnected(): void
 ```
 
+Called when the host is connected to the component tree. For custom
+element hosts, this corresponds to the `connectedCallback()` lifecycle,
+which is only called when the component is connected to the document.
+
 #### Returns
 
 `void`
@@ -114,9 +118,9 @@ hostConnected(): void
 
 `ReactiveController.hostConnected`
 
-#### Source
+#### Defined in
 
-[tanstack-form-controller.ts:102](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/lit-form/src/tanstack-form-controller.ts#L102)
+[tanstack-form-controller.ts:102](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/lit-form/src/tanstack-form-controller.ts#L102)
 
 ***
 
@@ -126,6 +130,11 @@ hostConnected(): void
 hostDisconnected(): void
 ```
 
+Called when the host is disconnected from the component tree. For custom
+element hosts, this corresponds to the `disconnectedCallback()` lifecycle,
+which is called the host or an ancestor component is disconnected from the
+document.
+
 #### Returns
 
 `void`
@@ -134,6 +143,6 @@ hostDisconnected(): void
 
 `ReactiveController.hostDisconnected`
 
-#### Source
+#### Defined in
 
-[tanstack-form-controller.ts:108](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/lit-form/src/tanstack-form-controller.ts#L108)
+[tanstack-form-controller.ts:108](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/lit-form/src/tanstack-form-controller.ts#L108)

docs/framework/react/reference/field.md

@@ -8,7 +8,7 @@ A function component that takes field options and a render function as children
 
 The `Field` component uses the `useField` hook internally to manage the field instance.
 
-## Type parameters
+## Type Parameters
 
 • **TParentData**
 
@@ -28,6 +28,6 @@ The `Field` component uses the `useField` hook internally to manage the field in
 
 `ReactNode`
 
-## Source
+## Defined in
 
-[useField.tsx:163](https://github.com/TanStack/form/blob/ada0211684adc85c41587b076e1217390ff5344e/packages/react-form/src/useField.tsx#L163)
+[useField.tsx:163](https://github.com/TanStack/form/blob/2bebfd5214c4cdfbf6feacb7b1e25a6825957062/packages/react-form/src/useField.tsx#L163)