Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: re-generate typedoc #8541

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: re-generate typedoc #8541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a16dc55
docs: re-generate typedoc
lachlancollins Jan 14, 2025
59f67b5
update tanstack config
lachlancollins Jan 15, 2025
8c3e33a
ci: apply automated fixes
autofix-ci[bot] Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 22 additions & 20 deletions docs/framework/angular/reference/functions/infinitequeryoptions.md
View file
Open in desktop
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 All @@ -13,7 +15,7 @@ The `queryKey` will be tagged with the type from `queryFn`.

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

## infiniteQueryOptions(options)
## Call Signature

```ts
function infiniteQueryOptions<
Expand All @@ -24,7 +26,7 @@ function infiniteQueryOptions<
TPageParam,
>(
options,
): UndefinedInitialDataInfiniteOptions<
): DefinedInitialDataInfiniteOptions<
TQueryFnData,
TError,
TData,
Expand All @@ -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,21 +48,23 @@ The `queryKey` will be tagged with the type from `queryFn`.

• **TError** = `Error`

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

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

• **TPageParam** = `unknown`

### Parameters

• **options**: [`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
#### options

[`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>

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

### Returns

[`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
[`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`

The tagged infinite query options.

Expand All @@ -68,11 +74,7 @@ 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/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/infinite-query-options.ts#L59)

## infiniteQueryOptions(options)
## Call Signature

```ts
function infiniteQueryOptions<
Expand All @@ -83,7 +85,7 @@ function infiniteQueryOptions<
TPageParam,
>(
options,
): DefinedInitialDataInfiniteOptions<
): UndefinedInitialDataInfiniteOptions<
TQueryFnData,
TError,
TData,
Expand All @@ -93,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 @@ -103,21 +107,23 @@ The `queryKey` will be tagged with the type from `queryFn`.

• **TError** = `Error`

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

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

• **TPageParam** = `unknown`

### Parameters

• **options**: [`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
#### options

[`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>

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

### Returns

[`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
[`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`

The tagged infinite query options.

Expand All @@ -126,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/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/infinite-query-options.ts#L91)
70 changes: 39 additions & 31 deletions docs/framework/angular/reference/functions/injectinfinitequery.md
View file
Open in desktop
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 @@ -16,7 +18,7 @@ A function that returns infinite query options.

The Angular injector to use.

## injectInfiniteQuery(optionsFn, injector)
## Call Signature

```ts
function injectInfiniteQuery<
Expand All @@ -25,9 +27,11 @@ function injectInfiniteQuery<
TData,
TQueryKey,
TPageParam,
>(optionsFn, injector?): CreateInfiniteQueryResult<TData, TError>
>(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,25 +41,29 @@ 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_ `QueryKey` = `QueryKey`
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]

• **TPageParam** = `unknown`

### Parameters

• **optionsFn**
#### optionsFn

() => [`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>

A function that returns infinite query options.

• **injector?**: `Injector`
#### injector?

`Injector`

The Angular injector to use.

### Returns

[`CreateInfiniteQueryResult`](../type-aliases/createinfinitequeryresult.md)\<`TData`, `TError`\>
[`DefinedCreateInfiniteQueryResult`](../type-aliases/definedcreateinfinitequeryresult.md)\<`TData`, `TError`\>

The infinite query result.

Expand All @@ -69,11 +77,7 @@ A function that returns infinite query options.

The Angular injector to use.

### Defined in

[inject-infinite-query.ts:30](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L30)

## injectInfiniteQuery(optionsFn, injector)
## Call Signature

```ts
function injectInfiniteQuery<
Expand All @@ -82,9 +86,11 @@ function injectInfiniteQuery<
TData,
TQueryKey,
TPageParam,
>(optionsFn, injector?): DefinedCreateInfiniteQueryResult<TData, TError>
>(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 @@ -94,25 +100,29 @@ 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_ `QueryKey` = `QueryKey`
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]

• **TPageParam** = `unknown`

### Parameters

• **optionsFn**
#### optionsFn

() => [`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>

A function that returns infinite query options.

• **injector?**: `Injector`
#### injector?

`Injector`

The Angular injector to use.

### Returns

[`DefinedCreateInfiniteQueryResult`](../type-aliases/definedcreateinfinitequeryresult.md)\<`TData`, `TError`\>
[`CreateInfiniteQueryResult`](../type-aliases/createinfinitequeryresult.md)\<`TData`, `TError`\>

The infinite query result.

Expand All @@ -126,11 +136,7 @@ A function that returns infinite query options.

The Angular injector to use.

### Defined in

[inject-infinite-query.ts:57](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L57)

## injectInfiniteQuery(optionsFn, injector)
## Call Signature

```ts
function injectInfiniteQuery<
Expand All @@ -142,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 @@ -151,19 +159,23 @@ 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_ `QueryKey` = `QueryKey`
• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[]

• **TPageParam** = `unknown`

### Parameters

• **optionsFn**
#### optionsFn

() => [`CreateInfiniteQueryOptions`](../interfaces/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\>

A function that returns infinite query options.

• **injector?**: `Injector`
#### injector?

`Injector`

The Angular injector to use.

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

The Angular injector to use.

### Defined in

[inject-infinite-query.ts:84](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L84)
16 changes: 10 additions & 6 deletions docs/framework/angular/reference/functions/injectisfetching.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,32 @@ 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.

Can be used for app-wide loading indicators

## Parameters

• **filters?**: `QueryFilters`
### filters?

`QueryFilters`

The filters to apply to the query.

• **injector?**: `Injector`
### injector?

`Injector`

The Angular injector to use.

Expand All @@ -29,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/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-is-fetching.ts#L17)
Loading
Loading