diff --git a/docs/config.json b/docs/config.json index f3611017e0..2bf9b064b6 100644 --- a/docs/config.json +++ b/docs/config.json @@ -747,11 +747,20 @@ }, { "label": "Functions / createQuery", - "to": "framework/svelte/reference/createquery" + "to": "framework/svelte/reference/createQuery" }, { "label": "Functions / createMutation", - "to": "framework/svelte/reference/createmutation" + "to": "framework/svelte/reference/createMutation" + } + ] + }, + { + "label": "angular", + "children": [ + { + "label": "Angular Reference", + "to": "framework/angular/reference/index" } ] } diff --git a/docs/framework/angular/reference/BaseMutationNarrowing.md b/docs/framework/angular/reference/BaseMutationNarrowing.md new file mode 100644 index 0000000000..b8d84d615d --- /dev/null +++ b/docs/framework/angular/reference/BaseMutationNarrowing.md @@ -0,0 +1,96 @@ +--- +id: BaseMutationNarrowing +title: BaseMutationNarrowing +--- + +# Interface: BaseMutationNarrowing\ + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TVariables** = `unknown` + +• **TContext** = `unknown` + +## Properties + +### isError() + +```ts +isError: (this) => this is CreateMutationResult, Object> & Object>; +``` + +#### Parameters + +• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\> + +#### Returns + +`this is CreateMutationResult, Object> & Object>` + +#### Defined in + +[types.ts:248](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L248) + +--- + +### isIdle() + +```ts +isIdle: (this) => this is CreateMutationResult, Object> & Object>; +``` + +#### Parameters + +• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\> + +#### Returns + +`this is CreateMutationResult, Object> & Object>` + +#### Defined in + +[types.ts:278](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L278) + +--- + +### isPending() + +```ts +isPending: (this) => this is CreateMutationResult, Object> & Object>; +``` + +#### Parameters + +• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\> + +#### Returns + +`this is CreateMutationResult, Object> & Object>` + +#### Defined in + +[types.ts:263](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L263) + +--- + +### isSuccess() + +```ts +isSuccess: (this) => this is CreateMutationResult, Object> & Object>; +``` + +#### Parameters + +• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\> + +#### Returns + +`this is CreateMutationResult, Object> & Object>` + +#### Defined in + +[types.ts:233](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L233) diff --git a/docs/framework/angular/reference/BaseQueryNarrowing.md b/docs/framework/angular/reference/BaseQueryNarrowing.md new file mode 100644 index 0000000000..f48590b8d6 --- /dev/null +++ b/docs/framework/angular/reference/BaseQueryNarrowing.md @@ -0,0 +1,72 @@ +--- +id: BaseQueryNarrowing +title: BaseQueryNarrowing +--- + +# Interface: BaseQueryNarrowing\ + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +## Properties + +### isError() + +```ts +isError: (this) => this is CreateBaseQueryResult>; +``` + +#### Parameters + +• **this**: [`CreateBaseQueryResult`](CreateBaseQueryResult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\> + +#### Returns + +`this is CreateBaseQueryResult>` + +#### Defined in + +[types.ts:75](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L75) + +--- + +### isPending() + +```ts +isPending: (this) => this is CreateBaseQueryResult>; +``` + +#### Parameters + +• **this**: [`CreateBaseQueryResult`](CreateBaseQueryResult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\> + +#### Returns + +`this is CreateBaseQueryResult>` + +#### Defined in + +[types.ts:82](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L82) + +--- + +### isSuccess() + +```ts +isSuccess: (this) => this is CreateBaseQueryResult>; +``` + +#### Parameters + +• **this**: [`CreateBaseQueryResult`](CreateBaseQueryResult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\> + +#### Returns + +`this is CreateBaseQueryResult>` + +#### Defined in + +[types.ts:68](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L68) diff --git a/docs/framework/angular/reference/CreateBaseMutationResult.md b/docs/framework/angular/reference/CreateBaseMutationResult.md new file mode 100644 index 0000000000..81a9913805 --- /dev/null +++ b/docs/framework/angular/reference/CreateBaseMutationResult.md @@ -0,0 +1,32 @@ +--- +id: CreateBaseMutationResult +title: CreateBaseMutationResult +--- + +# Type Alias: CreateBaseMutationResult\ + +```ts +type CreateBaseMutationResult: Override, object> & object; +``` + +## Type declaration + +### mutateAsync + +```ts +mutateAsync: CreateMutateAsyncFunction +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TVariables** = `unknown` + +• **TContext** = `unknown` + +## Defined in + +[types.ts:198](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L198) diff --git a/docs/framework/angular/reference/CreateBaseQueryOptions.md b/docs/framework/angular/reference/CreateBaseQueryOptions.md new file mode 100644 index 0000000000..c371959980 --- /dev/null +++ b/docs/framework/angular/reference/CreateBaseQueryOptions.md @@ -0,0 +1,22 @@ +--- +id: CreateBaseQueryOptions +title: CreateBaseQueryOptions +--- + +# Interface: CreateBaseQueryOptions\ + +## Extends + +- `QueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\> + +## Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `DefaultError` + +• **TData** = `TQueryFnData` + +• **TQueryData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` diff --git a/docs/framework/angular/reference/CreateBaseQueryResult.md b/docs/framework/angular/reference/CreateBaseQueryResult.md new file mode 100644 index 0000000000..75874bc14f --- /dev/null +++ b/docs/framework/angular/reference/CreateBaseQueryResult.md @@ -0,0 +1,22 @@ +--- +id: CreateBaseQueryResult +title: CreateBaseQueryResult +--- + +# Type Alias: CreateBaseQueryResult\ + +```ts +type CreateBaseQueryResult: BaseQueryNarrowing & MapToSignals>; +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TState** = `QueryObserverResult`\<`TData`, `TError`\> + +## Defined in + +[types.ts:116](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L116) diff --git a/docs/framework/angular/reference/CreateInfiniteQueryOptions.md b/docs/framework/angular/reference/CreateInfiniteQueryOptions.md new file mode 100644 index 0000000000..dade8e1e30 --- /dev/null +++ b/docs/framework/angular/reference/CreateInfiniteQueryOptions.md @@ -0,0 +1,24 @@ +--- +id: CreateInfiniteQueryOptions +title: CreateInfiniteQueryOptions +--- + +# Interface: CreateInfiniteQueryOptions\ + +## Extends + +- `OmitKeyof`\<`InfiniteQueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`, `TPageParam`\>, `"suspense"`\> + +## Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `DefaultError` + +• **TData** = `TQueryFnData` + +• **TQueryData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +• **TPageParam** = `unknown` diff --git a/docs/framework/angular/reference/CreateInfiniteQueryResult.md b/docs/framework/angular/reference/CreateInfiniteQueryResult.md new file mode 100644 index 0000000000..1952fad5e2 --- /dev/null +++ b/docs/framework/angular/reference/CreateInfiniteQueryResult.md @@ -0,0 +1,20 @@ +--- +id: CreateInfiniteQueryResult +title: CreateInfiniteQueryResult +--- + +# Type Alias: CreateInfiniteQueryResult\ + +```ts +type CreateInfiniteQueryResult: MapToSignals>; +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +## Defined in + +[types.ts:143](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L143) diff --git a/docs/framework/angular/reference/CreateMutateAsyncFunction.md b/docs/framework/angular/reference/CreateMutateAsyncFunction.md new file mode 100644 index 0000000000..f72a828f78 --- /dev/null +++ b/docs/framework/angular/reference/CreateMutateAsyncFunction.md @@ -0,0 +1,24 @@ +--- +id: CreateMutateAsyncFunction +title: CreateMutateAsyncFunction +--- + +# Type Alias: CreateMutateAsyncFunction\ + +```ts +type CreateMutateAsyncFunction: MutateFunction; +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TVariables** = `void` + +• **TContext** = `unknown` + +## Defined in + +[types.ts:188](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L188) diff --git a/docs/framework/angular/reference/CreateMutateFunction.md b/docs/framework/angular/reference/CreateMutateFunction.md new file mode 100644 index 0000000000..d045b870d3 --- /dev/null +++ b/docs/framework/angular/reference/CreateMutateFunction.md @@ -0,0 +1,32 @@ +--- +id: CreateMutateFunction +title: CreateMutateFunction +--- + +# Type Alias: CreateMutateFunction()\ + +```ts +type CreateMutateFunction: (...args) => void; +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TVariables** = `void` + +• **TContext** = `unknown` + +## Parameters + +• ...**args**: `Parameters`\<`MutateFunction`\<`TData`, `TError`, `TVariables`, `TContext`\>\> + +## Returns + +`void` + +## Defined in + +[types.ts:176](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L176) diff --git a/docs/framework/angular/reference/CreateMutationOptions.md b/docs/framework/angular/reference/CreateMutationOptions.md new file mode 100644 index 0000000000..ffca256828 --- /dev/null +++ b/docs/framework/angular/reference/CreateMutationOptions.md @@ -0,0 +1,20 @@ +--- +id: CreateMutationOptions +title: CreateMutationOptions +--- + +# Interface: CreateMutationOptions\ + +## Extends + +- `OmitKeyof`\<`MutationObserverOptions`\<`TData`, `TError`, `TVariables`, `TContext`\>, `"_defaulted"`\> + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TVariables** = `void` + +• **TContext** = `unknown` diff --git a/docs/framework/angular/reference/CreateMutationResult.md b/docs/framework/angular/reference/CreateMutationResult.md new file mode 100644 index 0000000000..c242e766ee --- /dev/null +++ b/docs/framework/angular/reference/CreateMutationResult.md @@ -0,0 +1,26 @@ +--- +id: CreateMutationResult +title: CreateMutationResult +--- + +# Type Alias: CreateMutationResult\ + +```ts +type CreateMutationResult: BaseMutationNarrowing & MapToSignals>; +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TVariables** = `unknown` + +• **TContext** = `unknown` + +• **TState** = `CreateStatusBasedMutationResult`\<[`CreateBaseMutationResult`](CreateBaseMutationResult.md)\[`"status"`\], `TData`, `TError`, `TVariables`, `TContext`\> + +## Defined in + +[types.ts:292](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L292) diff --git a/docs/framework/angular/reference/CreateQueryOptions.md b/docs/framework/angular/reference/CreateQueryOptions.md new file mode 100644 index 0000000000..7ed8fc263d --- /dev/null +++ b/docs/framework/angular/reference/CreateQueryOptions.md @@ -0,0 +1,20 @@ +--- +id: CreateQueryOptions +title: CreateQueryOptions +--- + +# Interface: CreateQueryOptions\ + +## Extends + +- `OmitKeyof`\<[`CreateBaseQueryOptions`](CreateBaseQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`\>, `"suspense"`\> + +## Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `DefaultError` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` diff --git a/docs/framework/angular/reference/CreateQueryResult.md b/docs/framework/angular/reference/CreateQueryResult.md new file mode 100644 index 0000000000..2cc1ac2bd8 --- /dev/null +++ b/docs/framework/angular/reference/CreateQueryResult.md @@ -0,0 +1,20 @@ +--- +id: CreateQueryResult +title: CreateQueryResult +--- + +# Type Alias: CreateQueryResult\ + +```ts +type CreateQueryResult: CreateBaseQueryResult; +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +## Defined in + +[types.ts:126](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L126) diff --git a/docs/framework/angular/reference/DefinedCreateInfiniteQueryResult.md b/docs/framework/angular/reference/DefinedCreateInfiniteQueryResult.md new file mode 100644 index 0000000000..88f5b4016f --- /dev/null +++ b/docs/framework/angular/reference/DefinedCreateInfiniteQueryResult.md @@ -0,0 +1,22 @@ +--- +id: DefinedCreateInfiniteQueryResult +title: DefinedCreateInfiniteQueryResult +--- + +# Type Alias: DefinedCreateInfiniteQueryResult\ + +```ts +type DefinedCreateInfiniteQueryResult: MapToSignals; +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TDefinedInfiniteQueryObserver** = `DefinedInfiniteQueryObserverResult`\<`TData`, `TError`\> + +## Defined in + +[types.ts:151](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L151) diff --git a/docs/framework/angular/reference/DefinedCreateQueryResult.md b/docs/framework/angular/reference/DefinedCreateQueryResult.md new file mode 100644 index 0000000000..fb905dcc1a --- /dev/null +++ b/docs/framework/angular/reference/DefinedCreateQueryResult.md @@ -0,0 +1,22 @@ +--- +id: DefinedCreateQueryResult +title: DefinedCreateQueryResult +--- + +# Type Alias: DefinedCreateQueryResult\ + +```ts +type DefinedCreateQueryResult: MapToSignals; +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `DefaultError` + +• **TDefinedQueryObserver** = `DefinedQueryObserverResult`\<`TData`, `TError`\> + +## Defined in + +[types.ts:134](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L134) diff --git a/docs/framework/angular/reference/DefinedInitialDataInfiniteOptions.md b/docs/framework/angular/reference/DefinedInitialDataInfiniteOptions.md new file mode 100644 index 0000000000..df6672c34d --- /dev/null +++ b/docs/framework/angular/reference/DefinedInitialDataInfiniteOptions.md @@ -0,0 +1,34 @@ +--- +id: DefinedInitialDataInfiniteOptions +title: DefinedInitialDataInfiniteOptions +--- + +# Type Alias: DefinedInitialDataInfiniteOptions\ + +```ts +type DefinedInitialDataInfiniteOptions: CreateInfiniteQueryOptions & object; +``` + +## Type declaration + +### initialData + +```ts +initialData: NonUndefinedGuard> | () => NonUndefinedGuard>; +``` + +## Type Parameters + +• **TQueryFnData** + +• **TError** = `DefaultError` + +• **TData** = `InfiniteData`\<`TQueryFnData`\> + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +• **TPageParam** = `unknown` + +## Defined in + +[infinite-query-options.ts:32](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/infinite-query-options.ts#L32) diff --git a/docs/framework/angular/reference/DefinedInitialDataOptions.md b/docs/framework/angular/reference/DefinedInitialDataOptions.md new file mode 100644 index 0000000000..67f9338617 --- /dev/null +++ b/docs/framework/angular/reference/DefinedInitialDataOptions.md @@ -0,0 +1,32 @@ +--- +id: DefinedInitialDataOptions +title: DefinedInitialDataOptions +--- + +# Type Alias: DefinedInitialDataOptions\ + +```ts +type DefinedInitialDataOptions: CreateQueryOptions & object; +``` + +## Type declaration + +### initialData + +```ts +initialData: NonUndefinedGuard | () => NonUndefinedGuard; +``` + +## Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `DefaultError` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +## Defined in + +[query-options.ts:19](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/query-options.ts#L19) diff --git a/docs/framework/angular/reference/InjectMutationStateOptions.md b/docs/framework/angular/reference/InjectMutationStateOptions.md new file mode 100644 index 0000000000..5ba65b1f9e --- /dev/null +++ b/docs/framework/angular/reference/InjectMutationStateOptions.md @@ -0,0 +1,18 @@ +--- +id: InjectMutationStateOptions +title: InjectMutationStateOptions +--- + +# Interface: InjectMutationStateOptions + +## Properties + +### injector? + +```ts +optional injector: Injector; +``` + +#### Defined in + +[inject-mutation-state.ts:43](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-mutation-state.ts#L43) diff --git a/docs/framework/angular/reference/NonUndefinedGuard.md b/docs/framework/angular/reference/NonUndefinedGuard.md new file mode 100644 index 0000000000..5cd7eff03b --- /dev/null +++ b/docs/framework/angular/reference/NonUndefinedGuard.md @@ -0,0 +1,18 @@ +--- +id: NonUndefinedGuard +title: NonUndefinedGuard +--- + +# Type Alias: NonUndefinedGuard\ + +```ts +type NonUndefinedGuard: T extends undefined ? never : T; +``` + +## Type Parameters + +• **T** + +## Defined in + +[types.ts:316](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L316) diff --git a/docs/framework/angular/reference/QueriesOptions.md b/docs/framework/angular/reference/QueriesOptions.md new file mode 100644 index 0000000000..b56da403c7 --- /dev/null +++ b/docs/framework/angular/reference/QueriesOptions.md @@ -0,0 +1,24 @@ +--- +id: QueriesOptions +title: QueriesOptions +--- + +# Type Alias: QueriesOptions\ + +```ts +type QueriesOptions: TDepth["length"] extends MAXIMUM_DEPTH ? QueryObserverOptionsForCreateQueries[] : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetOptions] : T extends [infer Head, ...(infer Tail)] ? QueriesOptions<[...Tail], [...TResult, GetOptions], [...TDepth, 1]> : ReadonlyArray extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[]; +``` + +QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param + +## Type Parameters + +• **T** _extends_ `any`[] + +• **TResult** _extends_ `any`[] = [] + +• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = [] + +## Defined in + +[inject-queries.ts:108](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-queries.ts#L108) diff --git a/docs/framework/angular/reference/QueriesResults.md b/docs/framework/angular/reference/QueriesResults.md new file mode 100644 index 0000000000..c892133971 --- /dev/null +++ b/docs/framework/angular/reference/QueriesResults.md @@ -0,0 +1,24 @@ +--- +id: QueriesResults +title: QueriesResults +--- + +# Type Alias: QueriesResults\ + +```ts +type QueriesResults: TDepth["length"] extends MAXIMUM_DEPTH ? QueryObserverResult[] : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetResults] : T extends [infer Head, ...(infer Tail)] ? QueriesResults<[...Tail], [...TResult, GetResults], [...TDepth, 1]> : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverResult[] : QueryObserverResult[]; +``` + +QueriesResults reducer recursively maps type param to results + +## Type Parameters + +• **T** _extends_ `any`[] + +• **TResult** _extends_ `any`[] = [] + +• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = [] + +## Defined in + +[inject-queries.ts:151](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-queries.ts#L151) diff --git a/docs/framework/angular/reference/UndefinedInitialDataInfiniteOptions.md b/docs/framework/angular/reference/UndefinedInitialDataInfiniteOptions.md new file mode 100644 index 0000000000..81b2508c91 --- /dev/null +++ b/docs/framework/angular/reference/UndefinedInitialDataInfiniteOptions.md @@ -0,0 +1,34 @@ +--- +id: UndefinedInitialDataInfiniteOptions +title: UndefinedInitialDataInfiniteOptions +--- + +# Type Alias: UndefinedInitialDataInfiniteOptions\ + +```ts +type UndefinedInitialDataInfiniteOptions: CreateInfiniteQueryOptions & object; +``` + +## Type declaration + +### initialData? + +```ts +optional initialData: undefined; +``` + +## Type Parameters + +• **TQueryFnData** + +• **TError** = `DefaultError` + +• **TData** = `InfiniteData`\<`TQueryFnData`\> + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +• **TPageParam** = `unknown` + +## Defined in + +[infinite-query-options.ts:12](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/infinite-query-options.ts#L12) diff --git a/docs/framework/angular/reference/UndefinedInitialDataOptions.md b/docs/framework/angular/reference/UndefinedInitialDataOptions.md new file mode 100644 index 0000000000..3f3aab95f2 --- /dev/null +++ b/docs/framework/angular/reference/UndefinedInitialDataOptions.md @@ -0,0 +1,32 @@ +--- +id: UndefinedInitialDataOptions +title: UndefinedInitialDataOptions +--- + +# Type Alias: UndefinedInitialDataOptions\ + +```ts +type UndefinedInitialDataOptions: CreateQueryOptions & object; +``` + +## Type declaration + +### initialData? + +```ts +optional initialData: undefined; +``` + +## Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `DefaultError` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +## Defined in + +[query-options.ts:7](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/query-options.ts#L7) diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md new file mode 100644 index 0000000000..cbfd308e11 --- /dev/null +++ b/docs/framework/angular/reference/index.md @@ -0,0 +1,50 @@ +--- +id: '@tanstack/angular-query-experimental' +title: '@tanstack/angular-query-experimental' +--- + +# @tanstack/angular-query-experimental + +## Interfaces + +- [BaseMutationNarrowing](BaseMutationNarrowing.md) +- [BaseQueryNarrowing](BaseQueryNarrowing.md) +- [CreateBaseQueryOptions](CreateBaseQueryOptions.md) +- [CreateInfiniteQueryOptions](CreateInfiniteQueryOptions.md) +- [CreateMutationOptions](CreateMutationOptions.md) +- [CreateQueryOptions](CreateQueryOptions.md) +- [InjectMutationStateOptions](InjectMutationStateOptions.md) + +## Type Aliases + +- [CreateBaseMutationResult](CreateBaseMutationResult.md) +- [CreateBaseQueryResult](CreateBaseQueryResult.md) +- [CreateInfiniteQueryResult](CreateInfiniteQueryResult.md) +- [CreateMutateAsyncFunction](CreateMutateAsyncFunction.md) +- [CreateMutateFunction](CreateMutateFunction.md) +- [CreateMutationResult](CreateMutationResult.md) +- [CreateQueryResult](CreateQueryResult.md) +- [DefinedCreateInfiniteQueryResult](DefinedCreateInfiniteQueryResult.md) +- [DefinedCreateQueryResult](DefinedCreateQueryResult.md) +- [DefinedInitialDataInfiniteOptions](DefinedInitialDataInfiniteOptions.md) +- [DefinedInitialDataOptions](DefinedInitialDataOptions.md) +- [NonUndefinedGuard](NonUndefinedGuard.md) +- [QueriesOptions](QueriesOptions.md) +- [QueriesResults](QueriesResults.md) +- [UndefinedInitialDataInfiniteOptions](UndefinedInitialDataInfiniteOptions.md) +- [UndefinedInitialDataOptions](UndefinedInitialDataOptions.md) + +## Functions + +- [infiniteQueryOptions](infiniteQueryOptions.md) +- [injectInfiniteQuery](injectInfiniteQuery.md) +- [injectIsFetching](injectIsFetching.md) +- [injectIsMutating](injectIsMutating.md) +- [injectMutation](injectMutation.md) +- [injectMutationState](injectMutationState.md) +- [injectQueries](injectQueries.md) +- [injectQuery](injectQuery.md) +- [injectQueryClient](injectQueryClient.md) +- [provideAngularQuery](provideAngularQuery.md) +- [provideQueryClient](provideQueryClient.md) +- [queryOptions](queryOptions.md) diff --git a/docs/framework/angular/reference/infiniteQueryOptions.md b/docs/framework/angular/reference/infiniteQueryOptions.md new file mode 100644 index 0000000000..f26c21eb4e --- /dev/null +++ b/docs/framework/angular/reference/infiniteQueryOptions.md @@ -0,0 +1,120 @@ +--- +id: infiniteQueryOptions +title: infiniteQueryOptions +--- + +# Function: infiniteQueryOptions() + +Allows to share and re-use infinite query options in a type-safe way. + +The `queryKey` will be tagged with the type from `queryFn`. + +## Param + +The infinite query options to tag with the type from `queryFn`. + +## infiniteQueryOptions(options) + +```ts +function infiniteQueryOptions< + TQueryFnData, + TError, + TData, + TQueryKey, + TPageParam, +>( + options, +): UndefinedInitialDataInfiniteOptions< + TQueryFnData, + TError, + TData, + TQueryKey, + TPageParam +> & + object +``` + +Allows to share and re-use infinite query options in a type-safe way. + +The `queryKey` will be tagged with the type from `queryFn`. + +### Type Parameters + +• **TQueryFnData** + +• **TError** = `Error` + +• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +• **TPageParam** = `unknown` + +### Parameters + +• **options**: [`UndefinedInitialDataInfiniteOptions`](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` + +The tagged infinite query options. + +### Defined in + +[infinite-query-options.ts:59](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/infinite-query-options.ts#L59) + +## infiniteQueryOptions(options) + +```ts +function infiniteQueryOptions< + TQueryFnData, + TError, + TData, + TQueryKey, + TPageParam, +>( + options, +): DefinedInitialDataInfiniteOptions< + TQueryFnData, + TError, + TData, + TQueryKey, + TPageParam +> & + object +``` + +Allows to share and re-use infinite query options in a type-safe way. + +The `queryKey` will be tagged with the type from `queryFn`. + +### Type Parameters + +• **TQueryFnData** + +• **TError** = `Error` + +• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +• **TPageParam** = `unknown` + +### Parameters + +• **options**: [`DefinedInitialDataInfiniteOptions`](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` + +The tagged infinite query options. + +### Defined in + +[infinite-query-options.ts:91](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/infinite-query-options.ts#L91) diff --git a/docs/framework/angular/reference/injectInfiniteQuery.md b/docs/framework/angular/reference/injectInfiniteQuery.md new file mode 100644 index 0000000000..b013cb562d --- /dev/null +++ b/docs/framework/angular/reference/injectInfiniteQuery.md @@ -0,0 +1,158 @@ +--- +id: injectInfiniteQuery +title: injectInfiniteQuery +--- + +# Function: injectInfiniteQuery() + +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" + +## Param + +A function that returns infinite query options. + +## Param + +The Angular injector to use. + +## injectInfiniteQuery(optionsFn, injector) + +```ts +function injectInfiniteQuery< + TQueryFnData, + TError, + TData, + TQueryKey, + TPageParam, +>(optionsFn, injector?): CreateInfiniteQueryResult +``` + +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" + +### Type Parameters + +• **TQueryFnData** + +• **TError** = `Error` + +• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +• **TPageParam** = `unknown` + +### Parameters + +• **optionsFn** + +A function that returns infinite query options. + +• **injector?**: `Injector` + +The Angular injector to use. + +### Returns + +[`CreateInfiniteQueryResult`](CreateInfiniteQueryResult.md)\<`TData`, `TError`\> + +The infinite query result. + +### Defined in + +[inject-infinite-query.ts:30](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-infinite-query.ts#L30) + +## injectInfiniteQuery(optionsFn, injector) + +```ts +function injectInfiniteQuery< + TQueryFnData, + TError, + TData, + TQueryKey, + TPageParam, +>(optionsFn, injector?): DefinedCreateInfiniteQueryResult +``` + +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" + +### Type Parameters + +• **TQueryFnData** + +• **TError** = `Error` + +• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +• **TPageParam** = `unknown` + +### Parameters + +• **optionsFn** + +A function that returns infinite query options. + +• **injector?**: `Injector` + +The Angular injector to use. + +### Returns + +[`DefinedCreateInfiniteQueryResult`](DefinedCreateInfiniteQueryResult.md)\<`TData`, `TError`\> + +The infinite query result. + +### Defined in + +[inject-infinite-query.ts:57](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-infinite-query.ts#L57) + +## injectInfiniteQuery(optionsFn, injector) + +```ts +function injectInfiniteQuery< + TQueryFnData, + TError, + TData, + TQueryKey, + TPageParam, +>(optionsFn, injector?): CreateInfiniteQueryResult +``` + +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" + +### Type Parameters + +• **TQueryFnData** + +• **TError** = `Error` + +• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +• **TPageParam** = `unknown` + +### Parameters + +• **optionsFn** + +A function that returns infinite query options. + +• **injector?**: `Injector` + +The Angular injector to use. + +### Returns + +[`CreateInfiniteQueryResult`](CreateInfiniteQueryResult.md)\<`TData`, `TError`\> + +The infinite query result. + +### Defined in + +[inject-infinite-query.ts:84](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-infinite-query.ts#L84) diff --git a/docs/framework/angular/reference/injectIsFetching.md b/docs/framework/angular/reference/injectIsFetching.md new file mode 100644 index 0000000000..c998ea7a69 --- /dev/null +++ b/docs/framework/angular/reference/injectIsFetching.md @@ -0,0 +1,35 @@ +--- +id: injectIsFetching +title: injectIsFetching +--- + +# Function: injectIsFetching() + +```ts +function injectIsFetching(filters?, injector?): Signal +``` + +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` + +The filters to apply to the query. + +• **injector?**: `Injector` + +The Angular injector to use. + +## Returns + +`Signal`\<`number`\> + +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) diff --git a/docs/framework/angular/reference/injectIsMutating.md b/docs/framework/angular/reference/injectIsMutating.md new file mode 100644 index 0000000000..1016bf049a --- /dev/null +++ b/docs/framework/angular/reference/injectIsMutating.md @@ -0,0 +1,34 @@ +--- +id: injectIsMutating +title: injectIsMutating +--- + +# Function: injectIsMutating() + +```ts +function injectIsMutating(filters?, injector?): Signal +``` + +Injects a signal that tracks the number of mutations that your application is fetching. + +Can be used for app-wide loading indicators + +## Parameters + +• **filters?**: `MutationFilters` + +The filters to apply to the query. + +• **injector?**: `Injector` + +The Angular injector to use. + +## Returns + +`Signal`\<`number`\> + +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) diff --git a/docs/framework/angular/reference/injectMutation.md b/docs/framework/angular/reference/injectMutation.md new file mode 100644 index 0000000000..c2dfacdaa5 --- /dev/null +++ b/docs/framework/angular/reference/injectMutation.md @@ -0,0 +1,47 @@ +--- +id: injectMutation +title: injectMutation +--- + +# Function: injectMutation() + +```ts +function injectMutation( + optionsFn, + injector?, +): CreateMutationResult +``` + +Injects a mutation: an imperative function that can be invoked which typically performs server side effects. + +Unlike queries, mutations are not run automatically. + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `Error` + +• **TVariables** = `void` + +• **TContext** = `unknown` + +## Parameters + +• **optionsFn** + +A function that returns mutation options. + +• **injector?**: `Injector` + +The Angular injector to use. + +## Returns + +[`CreateMutationResult`](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) diff --git a/docs/framework/angular/reference/injectMutationState.md b/docs/framework/angular/reference/injectMutationState.md new file mode 100644 index 0000000000..c841b21b31 --- /dev/null +++ b/docs/framework/angular/reference/injectMutationState.md @@ -0,0 +1,39 @@ +--- +id: injectMutationState +title: injectMutationState +--- + +# Function: injectMutationState() + +```ts +function injectMutationState( + mutationStateOptionsFn, + options?, +): Signal +``` + +Injects a signal that tracks the state of all mutations. + +## Type Parameters + +• **TResult** = `MutationState`\<`unknown`, `Error`, `unknown`, `unknown`\> + +## Parameters + +• **mutationStateOptionsFn** = `...` + +A function that returns mutation state options. + +• **options?**: [`InjectMutationStateOptions`](InjectMutationStateOptions.md) + +The Angular injector to use. + +## Returns + +`Signal`\<`TResult`[]\> + +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) diff --git a/docs/framework/angular/reference/injectQueries.md b/docs/framework/angular/reference/injectQueries.md new file mode 100644 index 0000000000..c32d5279fa --- /dev/null +++ b/docs/framework/angular/reference/injectQueries.md @@ -0,0 +1,37 @@ +--- +id: injectQueries +title: injectQueries +--- + +# Function: injectQueries() + +```ts +function injectQueries( + __namedParameters, + injector?, +): Signal +``` + +## 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`[] + +## Parameters + +• **\_\_namedParameters** + +• **\_\_namedParameters.combine?** + +• **\_\_namedParameters.queries?**: `Signal`\<[`...(T extends [] ? [] : T extends [Head] ? [GetOptions] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions, GetOptions] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[])[]`]\> + +• **injector?**: `Injector` + +## Returns + +`Signal`\<`TCombinedResult`\> + +## Defined in + +[inject-queries.ts:188](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-queries.ts#L188) diff --git a/docs/framework/angular/reference/injectQuery.md b/docs/framework/angular/reference/injectQuery.md new file mode 100644 index 0000000000..dd6b18493a --- /dev/null +++ b/docs/framework/angular/reference/injectQuery.md @@ -0,0 +1,279 @@ +--- +id: injectQuery +title: injectQuery +--- + +# Function: injectQuery() + +Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. + +**Basic example** + +```ts +class ServiceOrComponent { + query = injectQuery(() => ({ + queryKey: ['repoData'], + queryFn: () => + this.#http.get('https://api.github.com/repos/tanstack/query'), + })) +} +``` + +Similar to `computed` from Angular, the function passed to `injectQuery` will be run in the reactive context. +In the example below, the query will be automatically enabled and executed when the filter signal changes +to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled. + +**Reactive example** + +```ts +class ServiceOrComponent { + filter = signal('') + + todosQuery = injectQuery(() => ({ + queryKey: ['todos', this.filter()], + queryFn: () => fetchTodos(this.filter()), + // Signals can be combined with expressions + enabled: !!this.filter(), + })) +} +``` + +## Param + +A function that returns query options. + +## Param + +The Angular injector to use. + +## See + +https://tanstack.com/query/latest/docs/framework/angular/guides/queries + +## injectQuery(optionsFn, injector) + +```ts +function injectQuery( + optionsFn, + injector?, +): DefinedCreateQueryResult +``` + +Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. + +**Basic example** + +```ts +class ServiceOrComponent { + query = injectQuery(() => ({ + queryKey: ['repoData'], + queryFn: () => + this.#http.get('https://api.github.com/repos/tanstack/query'), + })) +} +``` + +Similar to `computed` from Angular, the function passed to `injectQuery` will be run in the reactive context. +In the example below, the query will be automatically enabled and executed when the filter signal changes +to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled. + +**Reactive example** + +```ts +class ServiceOrComponent { + filter = signal('') + + todosQuery = injectQuery(() => ({ + queryKey: ['todos', this.filter()], + queryFn: () => fetchTodos(this.filter()), + // Signals can be combined with expressions + enabled: !!this.filter(), + })) +} +``` + +### Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `Error` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +### Parameters + +• **optionsFn** + +A function that returns query options. + +• **injector?**: `Injector` + +The Angular injector to use. + +### Returns + +[`DefinedCreateQueryResult`](DefinedCreateQueryResult.md)\<`TData`, `TError`\> + +The query result. + +### 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) + +## injectQuery(optionsFn, injector) + +```ts +function injectQuery( + optionsFn, + injector?, +): CreateQueryResult +``` + +Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. + +**Basic example** + +```ts +class ServiceOrComponent { + query = injectQuery(() => ({ + queryKey: ['repoData'], + queryFn: () => + this.#http.get('https://api.github.com/repos/tanstack/query'), + })) +} +``` + +Similar to `computed` from Angular, the function passed to `injectQuery` will be run in the reactive context. +In the example below, the query will be automatically enabled and executed when the filter signal changes +to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled. + +**Reactive example** + +```ts +class ServiceOrComponent { + filter = signal('') + + todosQuery = injectQuery(() => ({ + queryKey: ['todos', this.filter()], + queryFn: () => fetchTodos(this.filter()), + // Signals can be combined with expressions + enabled: !!this.filter(), + })) +} +``` + +### Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `Error` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +### Parameters + +• **optionsFn** + +A function that returns query options. + +• **injector?**: `Injector` + +The Angular injector to use. + +### Returns + +[`CreateQueryResult`](CreateQueryResult.md)\<`TData`, `TError`\> + +The query result. + +### 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) + +## injectQuery(optionsFn, injector) + +```ts +function injectQuery( + optionsFn, + injector?, +): CreateQueryResult +``` + +Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. + +**Basic example** + +```ts +class ServiceOrComponent { + query = injectQuery(() => ({ + queryKey: ['repoData'], + queryFn: () => + this.#http.get('https://api.github.com/repos/tanstack/query'), + })) +} +``` + +Similar to `computed` from Angular, the function passed to `injectQuery` will be run in the reactive context. +In the example below, the query will be automatically enabled and executed when the filter signal changes +to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled. + +**Reactive example** + +```ts +class ServiceOrComponent { + filter = signal('') + + todosQuery = injectQuery(() => ({ + queryKey: ['todos', this.filter()], + queryFn: () => fetchTodos(this.filter()), + // Signals can be combined with expressions + enabled: !!this.filter(), + })) +} +``` + +### Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `Error` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +### Parameters + +• **optionsFn** + +A function that returns query options. + +• **injector?**: `Injector` + +The Angular injector to use. + +### Returns + +[`CreateQueryResult`](CreateQueryResult.md)\<`TData`, `TError`\> + +The query result. + +### 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) diff --git a/docs/framework/angular/reference/injectQueryClient.md b/docs/framework/angular/reference/injectQueryClient.md new file mode 100644 index 0000000000..53da63baae --- /dev/null +++ b/docs/framework/angular/reference/injectQueryClient.md @@ -0,0 +1,88 @@ +--- +id: injectQueryClient +title: injectQueryClient +--- + +# Function: injectQueryClient() + +Injects the `QueryClient` instance into the component or service. + +**Example** + +```ts +const queryClient = injectQueryClient() +``` + +## injectQueryClient() + +```ts +function injectQueryClient(): QueryClient +``` + +Injects the `QueryClient` instance into the component or service. + +**Example** + +```ts +const queryClient = injectQueryClient() +``` + +### Returns + +`QueryClient` + +### Defined in + +[inject-query-client.ts:16](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query-client.ts#L16) + +## injectQueryClient(injectOptions) + +```ts +function injectQueryClient(injectOptions): QueryClient +``` + +Injects the `QueryClient` instance into the component or service. + +**Example** + +```ts +const queryClient = injectQueryClient() +``` + +### Parameters + +• **injectOptions**: `InjectOptions` & `object` & `object` + +### Returns + +`QueryClient` + +### Defined in + +[inject-query-client.ts:16](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query-client.ts#L16) + +## injectQueryClient(injectOptions) + +```ts +function injectQueryClient(injectOptions): null | QueryClient +``` + +Injects the `QueryClient` instance into the component or service. + +**Example** + +```ts +const queryClient = injectQueryClient() +``` + +### Parameters + +• **injectOptions**: `InjectOptions` & `object` + +### Returns + +`null` \| `QueryClient` + +### Defined in + +[inject-query-client.ts:16](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query-client.ts#L16) diff --git a/docs/framework/angular/reference/provideAngularQuery.md b/docs/framework/angular/reference/provideAngularQuery.md new file mode 100644 index 0000000000..8be6f5af0c --- /dev/null +++ b/docs/framework/angular/reference/provideAngularQuery.md @@ -0,0 +1,64 @@ +--- +id: provideAngularQuery +title: provideAngularQuery +--- + +# Function: provideAngularQuery() + +```ts +function provideAngularQuery(queryClient): EnvironmentProviders +``` + +Sets up providers necessary to enable TanStack Query functionality for Angular applications. + +Allows to configure a `QueryClient`. + +**Example - standalone** + +```ts +import { + provideAngularQuery, + QueryClient, +} from '@tanstack/angular-query-experimental' + +bootstrapApplication(AppComponent, { + providers: [provideAngularQuery(new QueryClient())], +}) +``` + +**Example - NgModule-based** + +```ts +import { + provideAngularQuery, + QueryClient, +} from '@tanstack/angular-query-experimental' + +@NgModule({ + declarations: [AppComponent], + imports: [BrowserModule], + providers: [provideAngularQuery(new QueryClient())], + bootstrap: [AppComponent], +}) +export class AppModule {} +``` + +## Parameters + +• **queryClient**: `QueryClient` + +A `QueryClient` instance. + +## Returns + +`EnvironmentProviders` + +A set of providers to set up TanStack Query. + +## See + +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) diff --git a/docs/framework/angular/reference/provideQueryClient.md b/docs/framework/angular/reference/provideQueryClient.md new file mode 100644 index 0000000000..f9fbc7efaf --- /dev/null +++ b/docs/framework/angular/reference/provideQueryClient.md @@ -0,0 +1,27 @@ +--- +id: provideQueryClient +title: provideQueryClient +--- + +# Function: provideQueryClient() + +```ts +function provideQueryClient(value): Provider +``` + +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. + +## Parameters + +• **value**: `QueryClient` \| () => `QueryClient` + +## Returns + +`Provider` + +## Defined in + +[inject-query-client.ts:25](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/inject-query-client.ts#L25) diff --git a/docs/framework/angular/reference/queryOptions.md b/docs/framework/angular/reference/queryOptions.md new file mode 100644 index 0000000000..2e682f238e --- /dev/null +++ b/docs/framework/angular/reference/queryOptions.md @@ -0,0 +1,132 @@ +--- +id: queryOptions +title: queryOptions +--- + +# Function: queryOptions() + +Allows to share and re-use query options in a type-safe way. + +The `queryKey` will be tagged with the type from `queryFn`. + +**Example** + +```ts +const { queryKey } = queryOptions({ + queryKey: ['key'], + queryFn: () => Promise.resolve(5), + // ^? Promise +}) + +const queryClient = new QueryClient() +const data = queryClient.getQueryData(queryKey) +// ^? number | undefined +``` + +## Param + +The query options to tag with the type from `queryFn`. + +## queryOptions(options) + +```ts +function queryOptions( + options, +): UndefinedInitialDataOptions & object +``` + +Allows to share and re-use query options in a type-safe way. + +The `queryKey` will be tagged with the type from `queryFn`. + +**Example** + +```ts +const { queryKey } = queryOptions({ + queryKey: ['key'], + queryFn: () => Promise.resolve(5), + // ^? Promise +}) + +const queryClient = new QueryClient() +const data = queryClient.getQueryData(queryKey) +// ^? number | undefined +``` + +### Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `Error` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +### Parameters + +• **options**: [`UndefinedInitialDataOptions`](UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> + +The query options to tag with the type from `queryFn`. + +### Returns + +[`UndefinedInitialDataOptions`](UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` + +The tagged query options. + +### Defined in + +[query-options.ts:52](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/query-options.ts#L52) + +## queryOptions(options) + +```ts +function queryOptions( + options, +): DefinedInitialDataOptions & object +``` + +Allows to share and re-use query options in a type-safe way. + +The `queryKey` will be tagged with the type from `queryFn`. + +**Example** + +```ts +const { queryKey } = queryOptions({ + queryKey: ['key'], + queryFn: () => Promise.resolve(5), + // ^? Promise +}) + +const queryClient = new QueryClient() +const data = queryClient.getQueryData(queryKey) +// ^? number | undefined +``` + +### Type Parameters + +• **TQueryFnData** = `unknown` + +• **TError** = `Error` + +• **TData** = `TQueryFnData` + +• **TQueryKey** _extends_ `QueryKey` = `QueryKey` + +### Parameters + +• **options**: [`DefinedInitialDataOptions`](DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> + +The query options to tag with the type from `queryFn`. + +### Returns + +[`DefinedInitialDataOptions`](DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` + +The tagged query options. + +### Defined in + +[query-options.ts:85](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/query-options.ts#L85) diff --git a/docs/framework/svelte/reference/createbasemutationresult.md b/docs/framework/svelte/reference/CreateBaseMutationResult.md similarity index 91% rename from docs/framework/svelte/reference/createbasemutationresult.md rename to docs/framework/svelte/reference/CreateBaseMutationResult.md index 41b60c4c3c..bf36c6b7af 100644 --- a/docs/framework/svelte/reference/createbasemutationresult.md +++ b/docs/framework/svelte/reference/CreateBaseMutationResult.md @@ -29,4 +29,4 @@ mutateAsync: CreateMutateAsyncFunction ## Defined in -[packages/svelte-query/src/types.ts:113](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L113) +[packages/svelte-query/src/types.ts:113](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L113) diff --git a/docs/framework/svelte/reference/createbasequeryoptions.md b/docs/framework/svelte/reference/CreateBaseQueryOptions.md similarity index 91% rename from docs/framework/svelte/reference/createbasequeryoptions.md rename to docs/framework/svelte/reference/CreateBaseQueryOptions.md index d379b92ba8..c0f3ed4155 100644 --- a/docs/framework/svelte/reference/createbasequeryoptions.md +++ b/docs/framework/svelte/reference/CreateBaseQueryOptions.md @@ -25,4 +25,4 @@ Options for createBaseQuery ## Defined in -[packages/svelte-query/src/types.ts:23](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L23) +[packages/svelte-query/src/types.ts:23](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L23) diff --git a/docs/framework/svelte/reference/createbasequeryresult.md b/docs/framework/svelte/reference/CreateBaseQueryResult.md similarity index 87% rename from docs/framework/svelte/reference/createbasequeryresult.md rename to docs/framework/svelte/reference/CreateBaseQueryResult.md index ac031d191e..c8cfe86b32 100644 --- a/docs/framework/svelte/reference/createbasequeryresult.md +++ b/docs/framework/svelte/reference/CreateBaseQueryResult.md @@ -19,4 +19,4 @@ Result from createBaseQuery ## Defined in -[packages/svelte-query/src/types.ts:32](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L32) +[packages/svelte-query/src/types.ts:32](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L32) diff --git a/docs/framework/svelte/reference/createinfinitequeryoptions.md b/docs/framework/svelte/reference/CreateInfiniteQueryOptions.md similarity index 92% rename from docs/framework/svelte/reference/createinfinitequeryoptions.md rename to docs/framework/svelte/reference/CreateInfiniteQueryOptions.md index 9859a4fd03..1ccc6e62a5 100644 --- a/docs/framework/svelte/reference/createinfinitequeryoptions.md +++ b/docs/framework/svelte/reference/CreateInfiniteQueryOptions.md @@ -27,4 +27,4 @@ Options for createInfiniteQuery ## Defined in -[packages/svelte-query/src/types.ts:52](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L52) +[packages/svelte-query/src/types.ts:52](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L52) diff --git a/docs/framework/svelte/reference/createinfinitequeryresult.md b/docs/framework/svelte/reference/CreateInfiniteQueryResult.md similarity index 87% rename from docs/framework/svelte/reference/createinfinitequeryresult.md rename to docs/framework/svelte/reference/CreateInfiniteQueryResult.md index 3bc5437a76..9cf61260aa 100644 --- a/docs/framework/svelte/reference/createinfinitequeryresult.md +++ b/docs/framework/svelte/reference/CreateInfiniteQueryResult.md @@ -19,4 +19,4 @@ Result from createInfiniteQuery ## Defined in -[packages/svelte-query/src/types.ts:69](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L69) +[packages/svelte-query/src/types.ts:69](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L69) diff --git a/docs/framework/svelte/reference/createmutateasyncfunction.md b/docs/framework/svelte/reference/CreateMutateAsyncFunction.md similarity index 89% rename from docs/framework/svelte/reference/createmutateasyncfunction.md rename to docs/framework/svelte/reference/CreateMutateAsyncFunction.md index 86f9503dfd..1002beeda0 100644 --- a/docs/framework/svelte/reference/createmutateasyncfunction.md +++ b/docs/framework/svelte/reference/CreateMutateAsyncFunction.md @@ -21,4 +21,4 @@ type CreateMutateAsyncFunction: MutateFunct ## Defined in -[packages/svelte-query/src/types.ts:106](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L106) +[packages/svelte-query/src/types.ts:106](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L106) diff --git a/docs/framework/svelte/reference/createmutatefunction.md b/docs/framework/svelte/reference/CreateMutateFunction.md similarity index 90% rename from docs/framework/svelte/reference/createmutatefunction.md rename to docs/framework/svelte/reference/CreateMutateFunction.md index c392552350..d5bd8e33c3 100644 --- a/docs/framework/svelte/reference/createmutatefunction.md +++ b/docs/framework/svelte/reference/CreateMutateFunction.md @@ -29,4 +29,4 @@ type CreateMutateFunction: (...args) => voi ## Defined in -[packages/svelte-query/src/types.ts:97](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L97) +[packages/svelte-query/src/types.ts:97](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L97) diff --git a/docs/framework/svelte/reference/createmutationoptions.md b/docs/framework/svelte/reference/CreateMutationOptions.md similarity index 90% rename from docs/framework/svelte/reference/createmutationoptions.md rename to docs/framework/svelte/reference/CreateMutationOptions.md index 9a82d65f98..184f3fc92f 100644 --- a/docs/framework/svelte/reference/createmutationoptions.md +++ b/docs/framework/svelte/reference/CreateMutationOptions.md @@ -23,4 +23,4 @@ Options for createMutation ## Defined in -[packages/svelte-query/src/types.ts:87](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L87) +[packages/svelte-query/src/types.ts:87](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L87) diff --git a/docs/framework/svelte/reference/createmutationresult.md b/docs/framework/svelte/reference/CreateMutationResult.md similarity index 89% rename from docs/framework/svelte/reference/createmutationresult.md rename to docs/framework/svelte/reference/CreateMutationResult.md index 678f576921..b155a39d3e 100644 --- a/docs/framework/svelte/reference/createmutationresult.md +++ b/docs/framework/svelte/reference/CreateMutationResult.md @@ -23,4 +23,4 @@ Result from createMutation ## Defined in -[packages/svelte-query/src/types.ts:126](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L126) +[packages/svelte-query/src/types.ts:126](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L126) diff --git a/docs/framework/svelte/reference/createqueryoptions.md b/docs/framework/svelte/reference/CreateQueryOptions.md similarity index 90% rename from docs/framework/svelte/reference/createqueryoptions.md rename to docs/framework/svelte/reference/CreateQueryOptions.md index 0763b4c261..518834fcec 100644 --- a/docs/framework/svelte/reference/createqueryoptions.md +++ b/docs/framework/svelte/reference/CreateQueryOptions.md @@ -23,4 +23,4 @@ Options for createQuery ## Defined in -[packages/svelte-query/src/types.ts:38](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L38) +[packages/svelte-query/src/types.ts:38](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L38) diff --git a/docs/framework/svelte/reference/createqueryresult.md b/docs/framework/svelte/reference/CreateQueryResult.md similarity index 86% rename from docs/framework/svelte/reference/createqueryresult.md rename to docs/framework/svelte/reference/CreateQueryResult.md index 0d42d7f67e..f8d14053fe 100644 --- a/docs/framework/svelte/reference/createqueryresult.md +++ b/docs/framework/svelte/reference/CreateQueryResult.md @@ -19,4 +19,4 @@ Result from createQuery ## Defined in -[packages/svelte-query/src/types.ts:46](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L46) +[packages/svelte-query/src/types.ts:46](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L46) diff --git a/docs/framework/svelte/reference/definedcreatebasequeryresult.md b/docs/framework/svelte/reference/DefinedCreateBaseQueryResult.md similarity index 88% rename from docs/framework/svelte/reference/definedcreatebasequeryresult.md rename to docs/framework/svelte/reference/DefinedCreateBaseQueryResult.md index fab7a23c4e..1275d1ab97 100644 --- a/docs/framework/svelte/reference/definedcreatebasequeryresult.md +++ b/docs/framework/svelte/reference/DefinedCreateBaseQueryResult.md @@ -19,4 +19,4 @@ Options for createBaseQuery with initialData ## Defined in -[packages/svelte-query/src/types.ts:75](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L75) +[packages/svelte-query/src/types.ts:75](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L75) diff --git a/docs/framework/svelte/reference/definedcreatequeryresult.md b/docs/framework/svelte/reference/DefinedCreateQueryResult.md similarity index 87% rename from docs/framework/svelte/reference/definedcreatequeryresult.md rename to docs/framework/svelte/reference/DefinedCreateQueryResult.md index 65cbf736c7..f6f2c309cd 100644 --- a/docs/framework/svelte/reference/definedcreatequeryresult.md +++ b/docs/framework/svelte/reference/DefinedCreateQueryResult.md @@ -19,4 +19,4 @@ Options for createQuery with initialData ## Defined in -[packages/svelte-query/src/types.ts:81](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L81) +[packages/svelte-query/src/types.ts:81](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L81) diff --git a/docs/framework/svelte/reference/definedinitialdataoptions.md b/docs/framework/svelte/reference/DefinedInitialDataOptions.md similarity index 92% rename from docs/framework/svelte/reference/definedinitialdataoptions.md rename to docs/framework/svelte/reference/DefinedInitialDataOptions.md index b4f78f6b58..7c093250a5 100644 --- a/docs/framework/svelte/reference/definedinitialdataoptions.md +++ b/docs/framework/svelte/reference/DefinedInitialDataOptions.md @@ -29,4 +29,4 @@ initialData: NonUndefinedGuard | () => NonUndefinedGuard(options): HydrationBoundary +[`HydrationBoundary`](HydrationBoundary.md)\<`Props`, `Events`, `Slots`\> #### Overrides diff --git a/docs/framework/svelte/reference/mutationstateoptions.md b/docs/framework/svelte/reference/MutationStateOptions.md similarity index 90% rename from docs/framework/svelte/reference/mutationstateoptions.md rename to docs/framework/svelte/reference/MutationStateOptions.md index 669ab69090..f728f7dd78 100644 --- a/docs/framework/svelte/reference/mutationstateoptions.md +++ b/docs/framework/svelte/reference/MutationStateOptions.md @@ -39,4 +39,4 @@ optional select: (mutation) => TResult; ## Defined in -[packages/svelte-query/src/types.ts:140](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L140) +[packages/svelte-query/src/types.ts:140](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L140) diff --git a/docs/framework/svelte/reference/queriesoptions.md b/docs/framework/svelte/reference/QueriesOptions.md similarity index 94% rename from docs/framework/svelte/reference/queriesoptions.md rename to docs/framework/svelte/reference/QueriesOptions.md index b726b691bf..2aefbcec95 100644 --- a/docs/framework/svelte/reference/queriesoptions.md +++ b/docs/framework/svelte/reference/QueriesOptions.md @@ -21,4 +21,4 @@ QueriesOptions reducer recursively unwraps function arguments to infer/enforce t ## Defined in -[packages/svelte-query/src/createQueries.ts:110](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQueries.ts#L110) +[packages/svelte-query/src/createQueries.ts:110](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/createQueries.ts#L110) diff --git a/docs/framework/svelte/reference/queriesresults.md b/docs/framework/svelte/reference/QueriesResults.md similarity index 93% rename from docs/framework/svelte/reference/queriesresults.md rename to docs/framework/svelte/reference/QueriesResults.md index 9defc9c2b8..d6320eb192 100644 --- a/docs/framework/svelte/reference/queriesresults.md +++ b/docs/framework/svelte/reference/QueriesResults.md @@ -21,4 +21,4 @@ QueriesResults reducer recursively maps type param to results ## Defined in -[packages/svelte-query/src/createQueries.ts:152](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQueries.ts#L152) +[packages/svelte-query/src/createQueries.ts:152](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/createQueries.ts#L152) diff --git a/docs/framework/svelte/reference/storeorval.md b/docs/framework/svelte/reference/StoreOrVal.md similarity index 83% rename from docs/framework/svelte/reference/storeorval.md rename to docs/framework/svelte/reference/StoreOrVal.md index cf7bb05eba..ae6a6b54fc 100644 --- a/docs/framework/svelte/reference/storeorval.md +++ b/docs/framework/svelte/reference/StoreOrVal.md @@ -17,4 +17,4 @@ Allows a type to be either the base object or a store of that object ## Defined in -[packages/svelte-query/src/types.ts:20](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L20) +[packages/svelte-query/src/types.ts:20](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/types.ts#L20) diff --git a/docs/framework/svelte/reference/undefinedinitialdataoptions.md b/docs/framework/svelte/reference/UndefinedInitialDataOptions.md similarity index 91% rename from docs/framework/svelte/reference/undefinedinitialdataoptions.md rename to docs/framework/svelte/reference/UndefinedInitialDataOptions.md index 0686485922..8607b37866 100644 --- a/docs/framework/svelte/reference/undefinedinitialdataoptions.md +++ b/docs/framework/svelte/reference/UndefinedInitialDataOptions.md @@ -29,4 +29,4 @@ optional initialData: undefined; ## Defined in -[packages/svelte-query/src/queryOptions.ts:4](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/queryOptions.ts#L4) +[packages/svelte-query/src/queryOptions.ts:4](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/queryOptions.ts#L4) diff --git a/docs/framework/svelte/reference/createinfinitequery.md b/docs/framework/svelte/reference/createInfiniteQuery.md similarity index 69% rename from docs/framework/svelte/reference/createinfinitequery.md rename to docs/framework/svelte/reference/createInfiniteQuery.md index f2490be89b..f7cde0fdb7 100644 --- a/docs/framework/svelte/reference/createinfinitequery.md +++ b/docs/framework/svelte/reference/createInfiniteQuery.md @@ -29,14 +29,14 @@ function createInfiniteQuery< ## Parameters -• **options**: [`StoreOrVal`](storeorval.md)\<[`CreateInfiniteQueryOptions`](createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\>\> +• **options**: [`StoreOrVal`](StoreOrVal.md)\<[`CreateInfiniteQueryOptions`](CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\>\> • **queryClient?**: `QueryClient` ## Returns -[`CreateInfiniteQueryResult`](createinfinitequeryresult.md)\<`TData`, `TError`\> +[`CreateInfiniteQueryResult`](CreateInfiniteQueryResult.md)\<`TData`, `TError`\> ## Defined in -[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createInfiniteQuery.ts#L16) +[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/createInfiniteQuery.ts#L16) diff --git a/docs/framework/svelte/reference/createmutation.md b/docs/framework/svelte/reference/createMutation.md similarity index 70% rename from docs/framework/svelte/reference/createmutation.md rename to docs/framework/svelte/reference/createMutation.md index 0c3ed37dd6..8fc780361a 100644 --- a/docs/framework/svelte/reference/createmutation.md +++ b/docs/framework/svelte/reference/createMutation.md @@ -24,14 +24,14 @@ function createMutation( ## Parameters -• **options**: [`StoreOrVal`](storeorval.md)\<[`CreateMutationOptions`](createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TContext`\>\> +• **options**: [`StoreOrVal`](StoreOrVal.md)\<[`CreateMutationOptions`](CreateMutationOptions.md)\<`TData`, `TError`, `TVariables`, `TContext`\>\> • **queryClient?**: `QueryClient` ## Returns -[`CreateMutationResult`](createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`\> +[`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`\> ## Defined in -[packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createMutation.ts#L13) +[packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/createMutation.ts#L13) diff --git a/docs/framework/svelte/reference/createqueries.md b/docs/framework/svelte/reference/createQueries.md similarity index 94% rename from docs/framework/svelte/reference/createqueries.md rename to docs/framework/svelte/reference/createQueries.md index 4514bd2611..bb00c13b1a 100644 --- a/docs/framework/svelte/reference/createqueries.md +++ b/docs/framework/svelte/reference/createQueries.md @@ -24,7 +24,7 @@ function createQueries( • **\_\_namedParameters.combine?** -• **\_\_namedParameters.queries?**: [`StoreOrVal`](storeorval.md)\<[`...(T extends [] ? [] : T extends [Head] ? [GetOptions] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions, GetOptions] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[])[]`]\> +• **\_\_namedParameters.queries?**: [`StoreOrVal`](StoreOrVal.md)\<[`...(T extends [] ? [] : T extends [Head] ? [GetOptions] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions, GetOptions] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[])[]`]\> • **queryClient?**: `QueryClient` @@ -34,4 +34,4 @@ function createQueries( ## Defined in -[packages/svelte-query/src/createQueries.ts:186](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQueries.ts#L186) +[packages/svelte-query/src/createQueries.ts:186](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/createQueries.ts#L186) diff --git a/docs/framework/svelte/reference/createquery.md b/docs/framework/svelte/reference/createQuery.md similarity index 70% rename from docs/framework/svelte/reference/createquery.md rename to docs/framework/svelte/reference/createQuery.md index 33dd11784c..99716abfd4 100644 --- a/docs/framework/svelte/reference/createquery.md +++ b/docs/framework/svelte/reference/createQuery.md @@ -26,17 +26,17 @@ function createQuery( ### Parameters -• **options**: [`StoreOrVal`](storeorval.md)\<[`UndefinedInitialDataOptions`](undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> +• **options**: [`StoreOrVal`](StoreOrVal.md)\<[`UndefinedInitialDataOptions`](UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> • **queryClient?**: `QueryClient` ### Returns -[`CreateQueryResult`](createqueryresult.md)\<`TData`, `TError`\> +[`CreateQueryResult`](CreateQueryResult.md)\<`TData`, `TError`\> ### Defined in -[packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQuery.ts#L15) +[packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/createQuery.ts#L15) ## createQuery(options, queryClient) @@ -59,14 +59,14 @@ function createQuery( ### Parameters -• **options**: [`StoreOrVal`](storeorval.md)\<[`DefinedInitialDataOptions`](definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> +• **options**: [`StoreOrVal`](StoreOrVal.md)\<[`DefinedInitialDataOptions`](DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> • **queryClient?**: `QueryClient` ### Returns -[`DefinedCreateQueryResult`](definedcreatequeryresult.md)\<`TData`, `TError`\> +[`DefinedCreateQueryResult`](DefinedCreateQueryResult.md)\<`TData`, `TError`\> ### Defined in -[packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQuery.ts#L27) +[packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/createQuery.ts#L27) diff --git a/docs/framework/svelte/reference/getisrestoringcontext.md b/docs/framework/svelte/reference/getIsRestoringContext.md similarity index 85% rename from docs/framework/svelte/reference/getisrestoringcontext.md rename to docs/framework/svelte/reference/getIsRestoringContext.md index ca918485ec..4b80fe9a1a 100644 --- a/docs/framework/svelte/reference/getisrestoringcontext.md +++ b/docs/framework/svelte/reference/getIsRestoringContext.md @@ -17,4 +17,4 @@ Retrieves a `isRestoring` from Svelte's context ## Defined in -[packages/svelte-query/src/context.ts:28](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/context.ts#L28) +[packages/svelte-query/src/context.ts:28](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/context.ts#L28) diff --git a/docs/framework/svelte/reference/getqueryclientcontext.md b/docs/framework/svelte/reference/getQueryClientContext.md similarity index 84% rename from docs/framework/svelte/reference/getqueryclientcontext.md rename to docs/framework/svelte/reference/getQueryClientContext.md index 238441878f..ddbdf7c21d 100644 --- a/docs/framework/svelte/reference/getqueryclientcontext.md +++ b/docs/framework/svelte/reference/getQueryClientContext.md @@ -17,4 +17,4 @@ Retrieves a Client from Svelte's context ## Defined in -[packages/svelte-query/src/context.ts:9](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/context.ts#L9) +[packages/svelte-query/src/context.ts:9](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/context.ts#L9) diff --git a/docs/framework/svelte/reference/index.md b/docs/framework/svelte/reference/index.md index 10cd8ef7a9..05c9d0834b 100644 --- a/docs/framework/svelte/reference/index.md +++ b/docs/framework/svelte/reference/index.md @@ -9,49 +9,49 @@ title: '@tanstack/svelte-query' ### QueryClientProvider -Renames and re-exports [HydrationBoundary](hydrationboundary.md) +Renames and re-exports [HydrationBoundary](HydrationBoundary.md) ## Classes -- [HydrationBoundary](hydrationboundary.md) +- [HydrationBoundary](HydrationBoundary.md) ## Type Aliases -- [CreateBaseMutationResult](createbasemutationresult.md) -- [CreateBaseQueryOptions](createbasequeryoptions.md) -- [CreateBaseQueryResult](createbasequeryresult.md) -- [CreateInfiniteQueryOptions](createinfinitequeryoptions.md) -- [CreateInfiniteQueryResult](createinfinitequeryresult.md) -- [CreateMutateAsyncFunction](createmutateasyncfunction.md) -- [CreateMutateFunction](createmutatefunction.md) -- [CreateMutationOptions](createmutationoptions.md) -- [CreateMutationResult](createmutationresult.md) -- [CreateQueryOptions](createqueryoptions.md) -- [CreateQueryResult](createqueryresult.md) -- [DefinedCreateBaseQueryResult](definedcreatebasequeryresult.md) -- [DefinedCreateQueryResult](definedcreatequeryresult.md) -- [DefinedInitialDataOptions](definedinitialdataoptions.md) -- [MutationStateOptions](mutationstateoptions.md) -- [QueriesOptions](queriesoptions.md) -- [QueriesResults](queriesresults.md) -- [StoreOrVal](storeorval.md) -- [UndefinedInitialDataOptions](undefinedinitialdataoptions.md) +- [CreateBaseMutationResult](CreateBaseMutationResult.md) +- [CreateBaseQueryOptions](CreateBaseQueryOptions.md) +- [CreateBaseQueryResult](CreateBaseQueryResult.md) +- [CreateInfiniteQueryOptions](CreateInfiniteQueryOptions.md) +- [CreateInfiniteQueryResult](CreateInfiniteQueryResult.md) +- [CreateMutateAsyncFunction](CreateMutateAsyncFunction.md) +- [CreateMutateFunction](CreateMutateFunction.md) +- [CreateMutationOptions](CreateMutationOptions.md) +- [CreateMutationResult](CreateMutationResult.md) +- [CreateQueryOptions](CreateQueryOptions.md) +- [CreateQueryResult](CreateQueryResult.md) +- [DefinedCreateBaseQueryResult](DefinedCreateBaseQueryResult.md) +- [DefinedCreateQueryResult](DefinedCreateQueryResult.md) +- [DefinedInitialDataOptions](DefinedInitialDataOptions.md) +- [MutationStateOptions](MutationStateOptions.md) +- [QueriesOptions](QueriesOptions.md) +- [QueriesResults](QueriesResults.md) +- [StoreOrVal](StoreOrVal.md) +- [UndefinedInitialDataOptions](UndefinedInitialDataOptions.md) ## Functions -- [createInfiniteQuery](createinfinitequery.md) -- [createMutation](createmutation.md) -- [createQueries](createqueries.md) -- [createQuery](createquery.md) -- [getIsRestoringContext](getisrestoringcontext.md) -- [getQueryClientContext](getqueryclientcontext.md) -- [infiniteQueryOptions](infinitequeryoptions.md) -- [queryOptions](queryoptions.md) -- [setIsRestoringContext](setisrestoringcontext.md) -- [setQueryClientContext](setqueryclientcontext.md) -- [useHydrate](usehydrate.md) -- [useIsFetching](useisfetching.md) -- [useIsMutating](useismutating.md) -- [useIsRestoring](useisrestoring.md) -- [useMutationState](usemutationstate.md) -- [useQueryClient](usequeryclient.md) +- [createInfiniteQuery](createInfiniteQuery.md) +- [createMutation](createMutation.md) +- [createQueries](createQueries.md) +- [createQuery](createQuery.md) +- [getIsRestoringContext](getIsRestoringContext.md) +- [getQueryClientContext](getQueryClientContext.md) +- [infiniteQueryOptions](infiniteQueryOptions.md) +- [queryOptions](queryOptions.md) +- [setIsRestoringContext](setIsRestoringContext.md) +- [setQueryClientContext](setQueryClientContext.md) +- [useHydrate](useHydrate.md) +- [useIsFetching](useIsFetching.md) +- [useIsMutating](useIsMutating.md) +- [useIsRestoring](useIsRestoring.md) +- [useMutationState](useMutationState.md) +- [useQueryClient](useQueryClient.md) diff --git a/docs/framework/svelte/reference/infinitequeryoptions.md b/docs/framework/svelte/reference/infiniteQueryOptions.md similarity index 70% rename from docs/framework/svelte/reference/infinitequeryoptions.md rename to docs/framework/svelte/reference/infiniteQueryOptions.md index 234c7bec56..7fb5dee1fe 100644 --- a/docs/framework/svelte/reference/infinitequeryoptions.md +++ b/docs/framework/svelte/reference/infiniteQueryOptions.md @@ -38,12 +38,12 @@ function infiniteQueryOptions< ## Parameters -• **options**: [`CreateInfiniteQueryOptions`](createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\> +• **options**: [`CreateInfiniteQueryOptions`](CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\> ## Returns -[`CreateInfiniteQueryOptions`](createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\> +[`CreateInfiniteQueryOptions`](CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\> ## Defined in -[packages/svelte-query/src/infiniteQueryOptions.ts:4](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/infiniteQueryOptions.ts#L4) +[packages/svelte-query/src/infiniteQueryOptions.ts:4](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/infiniteQueryOptions.ts#L4) diff --git a/docs/framework/svelte/reference/queryoptions.md b/docs/framework/svelte/reference/queryOptions.md similarity index 70% rename from docs/framework/svelte/reference/queryoptions.md rename to docs/framework/svelte/reference/queryOptions.md index c3928af5c5..bca91eee2a 100644 --- a/docs/framework/svelte/reference/queryoptions.md +++ b/docs/framework/svelte/reference/queryOptions.md @@ -25,15 +25,15 @@ function queryOptions( ### Parameters -• **options**: [`UndefinedInitialDataOptions`](undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> +• **options**: [`UndefinedInitialDataOptions`](UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> ### Returns -[`UndefinedInitialDataOptions`](undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` +[`UndefinedInitialDataOptions`](UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` ### Defined in -[packages/svelte-query/src/queryOptions.ts:26](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/queryOptions.ts#L26) +[packages/svelte-query/src/queryOptions.ts:26](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/queryOptions.ts#L26) ## queryOptions(options) @@ -55,12 +55,12 @@ function queryOptions( ### Parameters -• **options**: [`DefinedInitialDataOptions`](definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> +• **options**: [`DefinedInitialDataOptions`](DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> ### Returns -[`DefinedInitialDataOptions`](definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` +[`DefinedInitialDataOptions`](DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` ### Defined in -[packages/svelte-query/src/queryOptions.ts:37](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/queryOptions.ts#L37) +[packages/svelte-query/src/queryOptions.ts:37](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/queryOptions.ts#L37) diff --git a/docs/framework/svelte/reference/setisrestoringcontext.md b/docs/framework/svelte/reference/setIsRestoringContext.md similarity index 86% rename from docs/framework/svelte/reference/setisrestoringcontext.md rename to docs/framework/svelte/reference/setIsRestoringContext.md index 1f147aadd4..9c0e8441e4 100644 --- a/docs/framework/svelte/reference/setisrestoringcontext.md +++ b/docs/framework/svelte/reference/setIsRestoringContext.md @@ -21,4 +21,4 @@ Sets a `isRestoring` on Svelte's context ## Defined in -[packages/svelte-query/src/context.ts:40](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/context.ts#L40) +[packages/svelte-query/src/context.ts:40](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/context.ts#L40) diff --git a/docs/framework/svelte/reference/setqueryclientcontext.md b/docs/framework/svelte/reference/setQueryClientContext.md similarity index 85% rename from docs/framework/svelte/reference/setqueryclientcontext.md rename to docs/framework/svelte/reference/setQueryClientContext.md index eb228e9327..e39855484e 100644 --- a/docs/framework/svelte/reference/setqueryclientcontext.md +++ b/docs/framework/svelte/reference/setQueryClientContext.md @@ -21,4 +21,4 @@ Sets a QueryClient on Svelte's context ## Defined in -[packages/svelte-query/src/context.ts:21](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/context.ts#L21) +[packages/svelte-query/src/context.ts:21](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/context.ts#L21) diff --git a/docs/framework/svelte/reference/usehydrate.md b/docs/framework/svelte/reference/useHydrate.md similarity index 85% rename from docs/framework/svelte/reference/usehydrate.md rename to docs/framework/svelte/reference/useHydrate.md index 6a99984929..6ead965980 100644 --- a/docs/framework/svelte/reference/usehydrate.md +++ b/docs/framework/svelte/reference/useHydrate.md @@ -23,4 +23,4 @@ function useHydrate(state?, options?, queryClient?): void ## Defined in -[packages/svelte-query/src/useHydrate.ts:8](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/useHydrate.ts#L8) +[packages/svelte-query/src/useHydrate.ts:8](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/useHydrate.ts#L8) diff --git a/docs/framework/svelte/reference/useisfetching.md b/docs/framework/svelte/reference/useIsFetching.md similarity index 86% rename from docs/framework/svelte/reference/useisfetching.md rename to docs/framework/svelte/reference/useIsFetching.md index eccc280fcf..0969e18e50 100644 --- a/docs/framework/svelte/reference/useisfetching.md +++ b/docs/framework/svelte/reference/useIsFetching.md @@ -21,4 +21,4 @@ function useIsFetching(filters?, queryClient?): Readable ## Defined in -[packages/svelte-query/src/useIsFetching.ts:10](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/useIsFetching.ts#L10) +[packages/svelte-query/src/useIsFetching.ts:10](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/useIsFetching.ts#L10) diff --git a/docs/framework/svelte/reference/useismutating.md b/docs/framework/svelte/reference/useIsMutating.md similarity index 86% rename from docs/framework/svelte/reference/useismutating.md rename to docs/framework/svelte/reference/useIsMutating.md index cdbbc8d61b..94bc295e50 100644 --- a/docs/framework/svelte/reference/useismutating.md +++ b/docs/framework/svelte/reference/useIsMutating.md @@ -21,4 +21,4 @@ function useIsMutating(filters?, queryClient?): Readable ## Defined in -[packages/svelte-query/src/useIsMutating.ts:10](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/useIsMutating.ts#L10) +[packages/svelte-query/src/useIsMutating.ts:10](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/useIsMutating.ts#L10) diff --git a/docs/framework/svelte/reference/useisrestoring.md b/docs/framework/svelte/reference/useIsRestoring.md similarity index 82% rename from docs/framework/svelte/reference/useisrestoring.md rename to docs/framework/svelte/reference/useIsRestoring.md index 6866d84016..d9eacc2ffb 100644 --- a/docs/framework/svelte/reference/useisrestoring.md +++ b/docs/framework/svelte/reference/useIsRestoring.md @@ -15,4 +15,4 @@ function useIsRestoring(): Readable ## Defined in -[packages/svelte-query/src/useIsRestoring.ts:4](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/useIsRestoring.ts#L4) +[packages/svelte-query/src/useIsRestoring.ts:4](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/useIsRestoring.ts#L4) diff --git a/docs/framework/svelte/reference/usemutationstate.md b/docs/framework/svelte/reference/useMutationState.md similarity index 72% rename from docs/framework/svelte/reference/usemutationstate.md rename to docs/framework/svelte/reference/useMutationState.md index e05eeb1b02..9a5b3ac26c 100644 --- a/docs/framework/svelte/reference/usemutationstate.md +++ b/docs/framework/svelte/reference/useMutationState.md @@ -15,7 +15,7 @@ function useMutationState(options, queryClient?): Readable ## Parameters -• **options**: [`MutationStateOptions`](mutationstateoptions.md)\<`TResult`\> = `{}` +• **options**: [`MutationStateOptions`](MutationStateOptions.md)\<`TResult`\> = `{}` • **queryClient?**: `QueryClient` @@ -25,4 +25,4 @@ function useMutationState(options, queryClient?): Readable ## Defined in -[packages/svelte-query/src/useMutationState.ts:24](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/useMutationState.ts#L24) +[packages/svelte-query/src/useMutationState.ts:24](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/useMutationState.ts#L24) diff --git a/docs/framework/svelte/reference/usequeryclient.md b/docs/framework/svelte/reference/useQueryClient.md similarity index 84% rename from docs/framework/svelte/reference/usequeryclient.md rename to docs/framework/svelte/reference/useQueryClient.md index dd4abc3bd7..c21290de18 100644 --- a/docs/framework/svelte/reference/usequeryclient.md +++ b/docs/framework/svelte/reference/useQueryClient.md @@ -19,4 +19,4 @@ function useQueryClient(queryClient?): QueryClient ## Defined in -[packages/svelte-query/src/useQueryClient.ts:4](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/useQueryClient.ts#L4) +[packages/svelte-query/src/useQueryClient.ts:4](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/useQueryClient.ts#L4) diff --git a/scripts/reference-docs.js b/scripts/reference-docs.js index bbae3c9d5f..f4767a045d 100644 --- a/scripts/reference-docs.js +++ b/scripts/reference-docs.js @@ -26,6 +26,18 @@ const options = { /** @type {Array<{name: string, entryPoints: Array, tsconfig: string, outputDir: string, exclude?: Array}>} */ const packages = [ + { + name: 'angular-query-experimental', + entryPoints: [ + resolve(__dirname, '../packages/angular-query-experimental/src/index.ts'), + ], + tsconfig: resolve( + __dirname, + '../packages/angular-query-experimental/tsconfig.json', + ), + outputDir: resolve(__dirname, '../docs/framework/angular/reference'), + exclude: ['./packages/query-core/**/*'], + }, { name: 'svelte-query', entryPoints: [resolve(__dirname, '../packages/svelte-query/src/index.ts')], diff --git a/scripts/typedoc-remove-prefix.js b/scripts/typedoc-remove-prefix.js index 14c5e2b670..fe00189d7d 100644 --- a/scripts/typedoc-remove-prefix.js +++ b/scripts/typedoc-remove-prefix.js @@ -29,7 +29,7 @@ export function load(app) { if (name[0] !== 'index') { name.splice(0, 1) } - const newBasename = name.join('.').toLowerCase() + const newBasename = name.join('.') urlMapping.url = newBasename urlMapping.model.url = newBasename return urlMapping