Skip to content

Commit

Permalink
update tanstack config
Browse files Browse the repository at this point in the history
  • Loading branch information
lachlancollins committed Jan 15, 2025
1 parent a16dc55 commit 59f67b5
Show file tree
Hide file tree
Showing 85 changed files with 599 additions and 670 deletions.
18 changes: 8 additions & 10 deletions docs/framework/angular/reference/functions/infinitequeryoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: infiniteQueryOptions
title: infiniteQueryOptions
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

# Function: infiniteQueryOptions()

Allows to share and re-use infinite query options in a type-safe way.
Expand Down Expand Up @@ -34,6 +36,8 @@ function infiniteQueryOptions<
object
```

Defined in: [infinite-query-options.ts:59](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L59)

Allows to share and re-use infinite query options in a type-safe way.

The `queryKey` will be tagged with the type from `queryFn`.
Expand All @@ -44,7 +48,7 @@ The `queryKey` will be tagged with the type from `queryFn`.

**TError** = `Error`

**TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
**TData** = `InfiniteData`\<`TQueryFnData`\>

**TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]

Expand All @@ -70,10 +74,6 @@ The tagged infinite query options.

The infinite query options to tag with the type from `queryFn`.

### Defined in

[infinite-query-options.ts:59](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L59)

## Call Signature

```ts
Expand All @@ -95,6 +95,8 @@ function infiniteQueryOptions<
object
```

Defined in: [infinite-query-options.ts:91](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L91)

Allows to share and re-use infinite query options in a type-safe way.

The `queryKey` will be tagged with the type from `queryFn`.
Expand All @@ -105,7 +107,7 @@ The `queryKey` will be tagged with the type from `queryFn`.

**TError** = `Error`

**TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
**TData** = `InfiniteData`\<`TQueryFnData`\>

**TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]

Expand All @@ -130,7 +132,3 @@ The tagged infinite query options.
### Param

The infinite query options to tag with the type from `queryFn`.

### Defined in

[infinite-query-options.ts:91](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L91)
26 changes: 11 additions & 15 deletions docs/framework/angular/reference/functions/injectinfinitequery.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: injectInfiniteQuery
title: injectInfiniteQuery
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

# Function: injectInfiniteQuery()

Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
Expand All @@ -28,6 +30,8 @@ function injectInfiniteQuery<
>(optionsFn, injector?): DefinedCreateInfiniteQueryResult<TData, TError>
```

Defined in: [inject-infinite-query.ts:29](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L29)

Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"

Expand All @@ -37,7 +41,7 @@ Infinite queries can additively "load more" data onto an existing set of data or

**TError** = `Error`

**TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
**TData** = `InfiniteData`\<`TQueryFnData`\>

**TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]

Expand Down Expand Up @@ -73,10 +77,6 @@ A function that returns infinite query options.

The Angular injector to use.

### Defined in

[inject-infinite-query.ts:29](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L29)

## Call Signature

```ts
Expand All @@ -89,6 +89,8 @@ function injectInfiniteQuery<
>(optionsFn, injector?): CreateInfiniteQueryResult<TData, TError>
```

Defined in: [inject-infinite-query.ts:54](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L54)

Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"

Expand All @@ -98,7 +100,7 @@ Infinite queries can additively "load more" data onto an existing set of data or

• **TError** = `Error`

• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
• **TData** = `InfiniteData`\<`TQueryFnData`\>

• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]

Expand Down Expand Up @@ -134,10 +136,6 @@ A function that returns infinite query options.

The Angular injector to use.

### Defined in

[inject-infinite-query.ts:54](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L54)

## Call Signature

```ts
Expand All @@ -150,6 +148,8 @@ function injectInfiniteQuery<
>(optionsFn, injector?): CreateInfiniteQueryResult<TData, TError>
```

Defined in: [inject-infinite-query.ts:79](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L79)

Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"

Expand All @@ -159,7 +159,7 @@ Infinite queries can additively "load more" data onto an existing set of data or

• **TError** = `Error`

• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
• **TData** = `InfiniteData`\<`TQueryFnData`\>

• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]

Expand Down Expand Up @@ -194,7 +194,3 @@ A function that returns infinite query options.
### Param

The Angular injector to use.

### Defined in

[inject-infinite-query.ts:79](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L79)
10 changes: 5 additions & 5 deletions docs/framework/angular/reference/functions/injectisfetching.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@ id: injectIsFetching
title: injectIsFetching
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

# Function: injectIsFetching()

```ts
function injectIsFetching(filters?, injector?): Signal<number>
```

Defined in: [inject-is-fetching.ts:17](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L17)

Injects a signal that tracks the number of queries that your application is loading or
fetching in the background.

Expand All @@ -18,7 +22,7 @@ Can be used for app-wide loading indicators

### filters?

`QueryFilters`\<`unknown`, `Error`, `unknown`, readonly `unknown`[]\>
`QueryFilters`

The filters to apply to the query.

Expand All @@ -33,7 +37,3 @@ The Angular injector to use.
`Signal`\<`number`\>

signal with number of loading or fetching queries.

## Defined in

[inject-is-fetching.ts:17](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L17)
10 changes: 5 additions & 5 deletions docs/framework/angular/reference/functions/injectismutating.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@ id: injectIsMutating
title: injectIsMutating
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

# Function: injectIsMutating()

```ts
function injectIsMutating(filters?, injector?): Signal<number>
```

Defined in: [inject-is-mutating.ts:16](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-mutating.ts#L16)

Injects a signal that tracks the number of mutations that your application is fetching.

Can be used for app-wide loading indicators
Expand All @@ -17,7 +21,7 @@ Can be used for app-wide loading indicators

### filters?

`MutationFilters`\<`unknown`, `Error`, `unknown`, `unknown`\>
`MutationFilters`

The filters to apply to the query.

Expand All @@ -32,7 +36,3 @@ The Angular injector to use.
`Signal`\<`number`\>

signal with number of fetching mutations.

## Defined in

[inject-is-mutating.ts:16](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-mutating.ts#L16)
8 changes: 4 additions & 4 deletions docs/framework/angular/reference/functions/injectmutation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: injectMutation
title: injectMutation
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

# Function: injectMutation()

```ts
Expand All @@ -12,6 +14,8 @@ function injectMutation<TData, TError, TVariables, TContext>(
): CreateMutationResult<TData, TError, TVariables, TContext>
```

Defined in: [inject-mutation.ts:33](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L33)

Injects a mutation: an imperative function that can be invoked which typically performs server side effects.

Unlike queries, mutations are not run automatically.
Expand Down Expand Up @@ -45,7 +49,3 @@ The Angular injector to use.
[`CreateMutationResult`](../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`\>

The mutation.

## Defined in

[inject-mutation.ts:33](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L33)
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: injectMutationState
title: injectMutationState
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

# Function: injectMutationState()

```ts
Expand All @@ -12,11 +14,13 @@ function injectMutationState<TResult>(
): Signal<TResult[]>
```

Defined in: [inject-mutation-state.ts:47](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L47)

Injects a signal that tracks the state of all mutations.

## Type Parameters

**TResult** = `MutationState`\<`unknown`, `Error`, `unknown`, `unknown`\>
**TResult** = `MutationState`

## Parameters

Expand All @@ -37,7 +41,3 @@ The Angular injector to use.
`Signal`\<`TResult`[]\>

The signal that tracks the state of all mutations.

## Defined in

[inject-mutation-state.ts:47](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L47)
12 changes: 6 additions & 6 deletions docs/framework/angular/reference/functions/injectqueries.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: injectQueries
title: injectQueries
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

# Function: injectQueries()

```ts
Expand All @@ -12,11 +14,13 @@ function injectQueries<T, TCombinedResult>(
): Signal<TCombinedResult>
```

Defined in: [inject-queries.ts:198](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L198)

## Type Parameters

**T** _extends_ `any`[]

• **TCombinedResult** = `T` _extends_ [] ? [] : `T` _extends_ [`Head`] ? [`GetResults`\<`Head`\>] : `T` _extends_ [`Head`, `...Tail[]`] ? [`...Tail[]`] _extends_ [] ? [] : [`...Tail[]`] _extends_ [`Head`] ? [`GetResults`\<`Head`\>, `GetResults`\<`Head`\>] : [`...Tail[]`] _extends_ [`Head`, `...Tail[]`] ? [`...Tail[]`] _extends_ [] ? [] : [`...Tail[]`] _extends_ [`Head`] ? [`GetResults`\<`Head`\>, `GetResults`\<`Head`\>, `GetResults`\<`Head`\>] : [`...Tail[]`] _extends_ [`Head`, `...Tail[]`] ? [`...(...)[]`] _extends_ [] ? [] : ... _extends_ ... ? ... : ... : [`...(...)[]`] _extends_ ...[] ? ...[] : ...[] : [`...Tail[]`] _extends_ `QueryObserverOptionsForCreateQueries`\<`TQueryFnData`, `TError`, `TData`, `any`\>[] ? `QueryObserverResult`\<`unknown` _extends_ `TData` ? `TQueryFnData` : `TData`, `unknown` _extends_ `TError` ? `Error` : `TError`\>[] : `QueryObserverResult`[] : `T` _extends_ `QueryObserverOptionsForCreateQueries`\<`TQueryFnData`, `TError`, `TData`, `any`\>[] ? `QueryObserverResult`\<`unknown` _extends_ `TData` ? `TQueryFnData` : `TData`, `unknown` _extends_ `TError` ? `Error` : `TError`\>[] : `QueryObserverResult`[]
• **TCombinedResult** = `T` _extends_ \[\] ? \[\] : `T` _extends_ \[`Head`\] ? \[`GetResults`\<`Head`\>\] : `T` _extends_ \[`Head`, `...Tail[]`\] ? \[`...Tail[]`\] _extends_ \[\] ? \[\] : \[`...Tail[]`\] _extends_ \[`Head`\] ? \[`GetResults`\<`Head`\>, `GetResults`\<`Head`\>\] : \[`...Tail[]`\] _extends_ \[`Head`, `...Tail[]`\] ? \[`...Tail[]`\] _extends_ \[\] ? \[\] : \[`...Tail[]`\] _extends_ \[`Head`\] ? \[`GetResults`\<`Head`\>, `GetResults`\<`Head`\>, `GetResults`\<`Head`\>\] : \[`...Tail[]`\] _extends_ \[`Head`, `...Tail[]`\] ? \[`...(...)[]`\] _extends_ \[\] ? \[\] : ... _extends_ ... ? ... : ... : \[`...(...)[]`\] _extends_ ...[] ? ...[] : ...[] : \[`...Tail[]`\] _extends_ `QueryObserverOptionsForCreateQueries`\<`TQueryFnData`, `TError`, `TData`, `any`\>[] ? `QueryObserverResult`\<`unknown` _extends_ `TData` ? `TQueryFnData` : `TData`, `unknown` _extends_ `TError` ? `Error` : `TError`\>[] : `QueryObserverResult`[] : `T` _extends_ `QueryObserverOptionsForCreateQueries`\<`TQueryFnData`, `TError`, `TData`, `any`\>[] ? `QueryObserverResult`\<`unknown` _extends_ `TData` ? `TQueryFnData` : `TData`, `unknown` _extends_ `TError` ? `Error` : `TError`\>[] : `QueryObserverResult`[]

## Parameters

Expand All @@ -28,7 +32,7 @@ function injectQueries<T, TCombinedResult>(

#### queries

`Signal`\<[`...(T extends [] ? [] : T extends [Head] ? [GetOptions<Head>] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] : QueryObserverOptionsForCreateQueries<unknown, Error, unknown, readonly (...)[]>[])[]`]\>
`Signal`\<\[`...(T extends [] ? [] : T extends [Head] ? [GetOptions<Head>] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] : QueryObserverOptionsForCreateQueries<unknown, Error, unknown, readonly (...)[]>[])[]`\]\>

### injector?

Expand All @@ -37,7 +41,3 @@ function injectQueries<T, TCombinedResult>(
## Returns

`Signal`\<`TCombinedResult`\>

## Defined in

[inject-queries.ts:198](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L198)
20 changes: 8 additions & 12 deletions docs/framework/angular/reference/functions/injectquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: injectQuery
title: injectQuery
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

# Function: injectQuery()

Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
Expand Down Expand Up @@ -59,6 +61,8 @@ function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
): DefinedCreateQueryResult<TData, TError>
```

Defined in: [inject-query.ts:53](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L53)

Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.

**Basic example**
Expand Down Expand Up @@ -140,10 +144,6 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
https://tanstack.com/query/latest/docs/framework/angular/guides/queries
### Defined in

[inject-query.ts:53](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L53)

## Call Signature
```ts
Expand All @@ -153,6 +153,8 @@ function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
): CreateQueryResult<TData, TError>
```

Defined in: [inject-query.ts:105](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L105)

Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.

**Basic example**
Expand Down Expand Up @@ -234,10 +236,6 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries

https://tanstack.com/query/latest/docs/framework/angular/guides/queries
### Defined in

[inject-query.ts:105](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L105)

## Call Signature

```ts
Expand All @@ -247,6 +245,8 @@ function injectQuery<TQueryFnData, TError, TData, TQueryKey>(
): CreateQueryResult<TData, TError>
```

Defined in: [inject-query.ts:157](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L157)

Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key.

**Basic example**
Expand Down Expand Up @@ -327,7 +327,3 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries
### See

https://tanstack.com/query/latest/docs/framework/angular/guides/queries
### Defined in

[inject-query.ts:157](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L157)
Loading

0 comments on commit 59f67b5

Please sign in to comment.