Skip to content

Commit

Permalink
chore(deps): replace rimraf with premove, update deps (#1112)
Browse files Browse the repository at this point in the history
* chore(deps): replace rimraf with premove, update deps

* ci: apply automated fixes and generate docs

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
  • Loading branch information
lachlancollins and autofix-ci[bot] authored Jan 13, 2025
1 parent 3e0ef50 commit 58628f7
Show file tree
Hide file tree
Showing 76 changed files with 986 additions and 1,370 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ stats.html
.nx/workspace-data
.pnpm-store
.tsup
.svelte-kit

vite.config.js.timestamp-*
vite.config.ts.timestamp-*
130 changes: 64 additions & 66 deletions docs/framework/angular/reference/classes/tanstackfield.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,17 @@ title: TanStackField

# Class: TanStackField\<TParentData, TName, TFieldValidator, TFormValidator, TData\>

Defined in: [tanstack-field.directive.ts:25](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L25)

## Type Parameters

**TParentData**

**TName** *extends* `DeepKeys`\<`TParentData`\>

**TFieldValidator** *extends* `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> \| `undefined` = `undefined`
**TFieldValidator** *extends*
\| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\>
\| `undefined` = `undefined`

**TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined`

Expand Down Expand Up @@ -44,9 +48,7 @@ new TanStackField<TParentData, TName, TFieldValidator, TFormValidator, TData>():
api: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;
```

#### Defined in

[tanstack-field.directive.ts:62](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L62)
Defined in: [tanstack-field.directive.ts:62](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L62)

***

Expand All @@ -56,15 +58,15 @@ api: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;
optional asyncAlways: boolean;
```

Defined in: [tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L48)

If `true`, always run async validation, even if there are errors emitted during synchronous validation.

#### Implementation of

`FieldOptions.asyncAlways`

#### Defined in

[tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L48)
```ts
FieldOptions.asyncAlways
```

***

Expand All @@ -74,15 +76,15 @@ If `true`, always run async validation, even if there are errors emitted during
optional asyncDebounceMs: number;
```

Defined in: [tanstack-field.directive.ts:47](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L47)

The default time to debounce async validation if there is not a more specific debounce time passed.

#### Implementation of

`FieldOptions.asyncDebounceMs`

#### Defined in

[tanstack-field.directive.ts:47](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L47)
```ts
FieldOptions.asyncDebounceMs
```

***

Expand All @@ -92,15 +94,15 @@ The default time to debounce async validation if there is not a more specific de
optional defaultMeta: Partial<FieldMeta>;
```

Defined in: [tanstack-field.directive.ts:60](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L60)

An optional object with default metadata for the field.

#### Implementation of

`FieldOptions.defaultMeta`

#### Defined in

[tanstack-field.directive.ts:60](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L60)
```ts
FieldOptions.defaultMeta
```

***

Expand All @@ -110,15 +112,15 @@ An optional object with default metadata for the field.
optional defaultValue: NoInfer<TData>;
```

Defined in: [tanstack-field.directive.ts:46](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L46)

An optional default value for the field.

#### Implementation of

`FieldOptions.defaultValue`

#### Defined in

[tanstack-field.directive.ts:46](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L46)
```ts
FieldOptions.defaultValue
```

***

Expand All @@ -128,15 +130,15 @@ An optional default value for the field.
optional listeners: NoInfer<FieldListeners<TParentData, TName, TFieldValidator, TFormValidator, TData>>;
```

Defined in: [tanstack-field.directive.ts:57](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L57)

A list of listeners which attach to the corresponding events

#### Implementation of

`FieldOptions.listeners`

#### Defined in

[tanstack-field.directive.ts:57](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L57)
```ts
FieldOptions.listeners
```

***

Expand All @@ -146,15 +148,15 @@ A list of listeners which attach to the corresponding events
name: TName;
```

Defined in: [tanstack-field.directive.ts:42](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L42)

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`

#### Defined in

[tanstack-field.directive.ts:42](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L42)
```ts
FieldOptions.name
```

***

Expand All @@ -164,9 +166,7 @@ The field name. The type will be `DeepKeys<TParentData>` to ensure your name is
tanstackField: FormApi<TParentData, TFormValidator>;
```

#### Defined in

[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L50)
Defined in: [tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L50)

***

Expand All @@ -176,14 +176,12 @@ tanstackField: FormApi<TParentData, TFormValidator>;
optional unmount: () => void;
```

Defined in: [tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L78)

#### Returns

`void`

#### Defined in

[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L78)

***

### validatorAdapter?
Expand All @@ -192,15 +190,15 @@ optional unmount: () => void;
optional validatorAdapter: TFieldValidator;
```

Defined in: [tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L49)

A validator provided by an extension, like `yupValidator` from `@tanstack/yup-form-adapter`

#### Implementation of

`FieldOptions.validatorAdapter`

#### Defined in

[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L49)
```ts
FieldOptions.validatorAdapter
```

***

Expand All @@ -210,15 +208,15 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo
optional validators: NoInfer<FieldValidators<TParentData, TName, TFieldValidator, TFormValidator, TData>>;
```

Defined in: [tanstack-field.directive.ts:54](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L54)

A list of validators to pass to the field

#### Implementation of

`FieldOptions.validators`

#### Defined in

[tanstack-field.directive.ts:54](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L54)
```ts
FieldOptions.validators
```

## Methods

Expand All @@ -228,6 +226,8 @@ A list of validators to pass to the field
ngOnChanges(): void
```

Defined in: [tanstack-field.directive.ts:90](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L90)

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
Expand All @@ -239,11 +239,9 @@ children are checked.

#### Implementation of

`OnChanges.ngOnChanges`

#### Defined in

[tanstack-field.directive.ts:90](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L90)
```ts
OnChanges.ngOnChanges
```

***

Expand All @@ -253,6 +251,8 @@ children are checked.
ngOnDestroy(): void
```

Defined in: [tanstack-field.directive.ts:86](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L86)

A callback method that performs custom clean-up, invoked immediately
before a directive, pipe, or service instance is destroyed.

Expand All @@ -262,11 +262,9 @@ before a directive, pipe, or service instance is destroyed.

#### Implementation of

`OnDestroy.ngOnDestroy`

#### Defined in

[tanstack-field.directive.ts:86](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L86)
```ts
OnDestroy.ngOnDestroy
```

***

Expand All @@ -276,6 +274,8 @@ before a directive, pipe, or service instance is destroyed.
ngOnInit(): void
```

Defined in: [tanstack-field.directive.ts:80](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L80)

A callback method that is invoked immediately after the
default change detector has checked the directive's
data-bound properties for the first time,
Expand All @@ -288,8 +288,6 @@ It is invoked only once when the directive is instantiated.

#### Implementation of

`OnInit.ngOnInit`

#### Defined in

[tanstack-field.directive.ts:80](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L80)
```ts
OnInit.ngOnInit
```
6 changes: 2 additions & 4 deletions docs/framework/angular/reference/functions/injectform.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ title: injectForm
function injectForm<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormValidator>
```

Defined in: [inject-form.ts:5](https://github.com/TanStack/form/blob/main/packages/angular-form/src/inject-form.ts#L5)

## Type Parameters

**TFormData**
Expand All @@ -24,7 +26,3 @@ function injectForm<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormV
## Returns

`FormApi`\<`TFormData`, `TFormValidator`\>

## Defined in

[inject-form.ts:5](https://github.com/TanStack/form/blob/main/packages/angular-form/src/inject-form.ts#L5)
6 changes: 2 additions & 4 deletions docs/framework/angular/reference/functions/injectstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ title: injectStore
function injectStore<TFormData, TFormValidator, TSelected>(form, selector?): Signal<TSelected>
```

Defined in: [inject-store.ts:4](https://github.com/TanStack/form/blob/main/packages/angular-form/src/inject-store.ts#L4)

## Type Parameters

**TFormData**
Expand All @@ -30,7 +32,3 @@ function injectStore<TFormData, TFormValidator, TSelected>(form, selector?): Sig
## Returns

`Signal`\<`TSelected`\>

## Defined in

[inject-store.ts:4](https://github.com/TanStack/form/blob/main/packages/angular-form/src/inject-store.ts#L4)
Loading

0 comments on commit 58628f7

Please sign in to comment.