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.

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(typedoc): use sub-folders for reference docs #7803

Merged
merged 1 commit into from
Jul 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 10 additions & 2 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -747,11 +747,11 @@
},
{
"label": "Functions / createQuery",
"to": "framework/svelte/reference/createQuery"
"to": "framework/svelte/reference/functions/createquery"
},
{
"label": "Functions / createMutation",
"to": "framework/svelte/reference/createMutation"
"to": "framework/svelte/reference/functions/createmutation"
}
]
},
Expand All @@ -761,6 +761,14 @@
{
"label": "Angular Reference",
"to": "framework/angular/reference/index"
},
{
"label": "Functions / injectQuery",
"to": "framework/angular/reference/functions/injectquery"
},
{
"label": "Functions / injectMutation",
"to": "framework/angular/reference/functions/injectmutation"
}
]
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,19 +52,25 @@ The `queryKey` will be tagged with the type from `queryFn`.

### Parameters

• **options**: [`UndefinedInitialDataInfiniteOptions`](UndefinedInitialDataInfiniteOptions.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

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

The tagged infinite query options.

The tagged infinite query options.

### Param

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

### Defined in

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

## infiniteQueryOptions(options)

Expand Down Expand Up @@ -105,16 +111,22 @@ The `queryKey` will be tagged with the type from `queryFn`.

### Parameters

• **options**: [`DefinedInitialDataInfiniteOptions`](DefinedInitialDataInfiniteOptions.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

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

The tagged infinite query options.

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/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/infinite-query-options.ts#L91)
[infinite-query-options.ts:91](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/infinite-query-options.ts#L91)
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,23 @@ The Angular injector to use.

### Returns

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

The infinite query result.

The infinite query result.

### Param

A function that returns infinite query options.

### Param

The Angular injector to use.

### Defined in

[inject-infinite-query.ts:30](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-infinite-query.ts#L30)
[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)

Expand Down Expand Up @@ -102,13 +112,23 @@ The Angular injector to use.

### Returns

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

The infinite query result.

The infinite query result.

### Param

A function that returns infinite query options.

### Param

The Angular injector to use.

### Defined in

[inject-infinite-query.ts:57](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-infinite-query.ts#L57)
[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)

Expand Down Expand Up @@ -149,10 +169,20 @@ The Angular injector to use.

### Returns

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

The infinite query result.

The infinite query result.

### Param

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/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-infinite-query.ts#L84)
[inject-infinite-query.ts:84](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L84)
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ signal with number of loading or fetching queries.

## Defined in

[inject-is-fetching.ts:17](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-is-fetching.ts#L17)
[inject-is-fetching.ts:17](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-is-fetching.ts#L17)
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ signal with number of fetching mutations.

## Defined in

[inject-is-mutating.ts:16](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-is-mutating.ts#L16)
[inject-is-mutating.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-is-mutating.ts#L16)
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ The Angular injector to use.

## Returns

[`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`\>
[`CreateMutationResult`](../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`\>

The mutation.

## Defined in

[inject-mutation.ts:38](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-mutation.ts#L38)
[inject-mutation.ts:38](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-mutation.ts#L38)
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Injects a signal that tracks the state of all mutations.

A function that returns mutation state options.

• **options?**: [`InjectMutationStateOptions`](InjectMutationStateOptions.md)
• **options?**: [`InjectMutationStateOptions`](../interfaces/injectmutationstateoptions.md)

The Angular injector to use.

Expand All @@ -36,4 +36,4 @@ The signal that tracks the state of all mutations.

## Defined in

[inject-mutation-state.ts:53](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-mutation-state.ts#L53)
[inject-mutation-state.ts:53](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-mutation-state.ts#L53)
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ function injectQueries<T, TCombinedResult>(

## Defined in

[inject-queries.ts:188](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-queries.ts#L188)
[inject-queries.ts:188](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-queries.ts#L188)
Original file line number Diff line number Diff line change
Expand Up @@ -114,17 +114,31 @@ The Angular injector to use.

### Returns

[`DefinedCreateQueryResult`](DefinedCreateQueryResult.md)\<`TData`, `TError`\>
[`DefinedCreateQueryResult`](../type-aliases/definedcreatequeryresult.md)\<`TData`, `TError`\>

The query result.

The query result.

### Param

A function that returns query options.

### Param

The Angular injector to use.

### See

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:53](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query.ts#L53)
[inject-query.ts:53](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query.ts#L53)

## injectQuery(optionsFn, injector)

Expand Down Expand Up @@ -190,17 +204,31 @@ The Angular injector to use.

### Returns

[`CreateQueryResult`](CreateQueryResult.md)\<`TData`, `TError`\>
[`CreateQueryResult`](../type-aliases/createqueryresult.md)\<`TData`, `TError`\>

The query result.

The query result.

### Param

A function that returns query options.

### Param

The Angular injector to use.

### See

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:102](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query.ts#L102)
[inject-query.ts:102](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query.ts#L102)

## injectQuery(optionsFn, injector)

Expand Down Expand Up @@ -266,14 +294,28 @@ The Angular injector to use.

### Returns

[`CreateQueryResult`](CreateQueryResult.md)\<`TData`, `TError`\>
[`CreateQueryResult`](../type-aliases/createqueryresult.md)\<`TData`, `TError`\>

The query result.

The query result.

### Param

A function that returns query options.

### Param

The Angular injector to use.

### See

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:151](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query.ts#L151)
[inject-query.ts:151](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query.ts#L151)
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const queryClient = injectQueryClient()

### Defined in

[inject-query-client.ts:16](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query-client.ts#L16)
[inject-query-client.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query-client.ts#L16)

## injectQueryClient(injectOptions)

Expand All @@ -59,7 +59,7 @@ const queryClient = injectQueryClient()

### Defined in

[inject-query-client.ts:16](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query-client.ts#L16)
[inject-query-client.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query-client.ts#L16)

## injectQueryClient(injectOptions)

Expand All @@ -85,4 +85,4 @@ const queryClient = injectQueryClient()

### Defined in

[inject-query-client.ts:16](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query-client.ts#L16)
[inject-query-client.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query-client.ts#L16)
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ https://tanstack.com/query/v5/docs/framework/angular/quick-start

## Defined in

[providers.ts:50](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/providers.ts#L50)
[providers.ts:50](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/providers.ts#L50)
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: provideQueryClient
function provideQueryClient(value): Provider
```

Usually [provideAngularQuery](provideAngularQuery.md) is used once to set up TanStack Query and the
Usually [provideAngularQuery](provideangularquery.md) is used once to set up TanStack Query and the
[https://tanstack.com/query/latest/docs/reference/QueryClient|QueryClient](https://tanstack.com/query/latest/docs/reference/QueryClient|QueryClient)
for the entire application. You can use `provideQueryClient` to provide a
different `QueryClient` instance for a part of the application.
Expand All @@ -24,4 +24,4 @@ different `QueryClient` instance for a part of the application.

## Defined in

[inject-query-client.ts:25](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query-client.ts#L25)
[inject-query-client.ts:25](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query-client.ts#L25)
Loading
Loading