docs(typedoc): Update output filename (#7764)

* docs: Update typedoc output filename * Run prettier
TanStack · Jul 19, 2024 · 144d3a8 · 144d3a8
1 parent 2786196
commit 144d3a8
Show file tree

Hide file tree

Showing 76 changed files with 1,915 additions and 94 deletions.
diff --git 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
@@ -0,0 +1,96 @@
+---
+id: BaseMutationNarrowing
+title: BaseMutationNarrowing
+---
+
+# Interface: BaseMutationNarrowing\<TData, TError, TVariables, TContext\>
+
+## Type Parameters
+
+• **TData** = `unknown`
+
+• **TError** = `DefaultError`
+
+• **TVariables** = `unknown`
+
+• **TContext** = `unknown`
+
+## Properties
+
+### isError()
+
+```ts
+isError: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverErrorResult<TData, TError, TVariables, TContext>, Object> & Object>;
+```
+
+#### Parameters
+
+• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\>
+
+#### Returns
+
+`this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverErrorResult<TData, TError, TVariables, TContext>, 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<TData, TError, TVariables, TContext, Override<MutationObserverIdleResult<TData, TError, TVariables, TContext>, Object> & Object>;
+```
+
+#### Parameters
+
+• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\>
+
+#### Returns
+
+`this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverIdleResult<TData, TError, TVariables, TContext>, 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<TData, TError, TVariables, TContext, Override<MutationObserverLoadingResult<TData, TError, TVariables, TContext>, Object> & Object>;
+```
+
+#### Parameters
+
+• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\>
+
+#### Returns
+
+`this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverLoadingResult<TData, TError, TVariables, TContext>, 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<TData, TError, TVariables, TContext, Override<MutationObserverSuccessResult<TData, TError, TVariables, TContext>, Object> & Object>;
+```
+
+#### Parameters
+
+• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\>
+
+#### Returns
+
+`this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverSuccessResult<TData, TError, TVariables, TContext>, 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
@@ -0,0 +1,72 @@
+---
+id: BaseQueryNarrowing
+title: BaseQueryNarrowing
+---
+
+# Interface: BaseQueryNarrowing\<TData, TError\>
+
+## Type Parameters
+
+• **TData** = `unknown`
+
+• **TError** = `DefaultError`
+
+## Properties
+
+### isError()
+
+```ts
+isError: (this) => this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"error", TData, TError>>;
+```
+
+#### Parameters
+
+• **this**: [`CreateBaseQueryResult`](CreateBaseQueryResult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\>
+
+#### Returns
+
+`this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"error", TData, TError>>`
+
+#### 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<TData, TError, CreateStatusBasedQueryResult<"pending", TData, TError>>;
+```
+
+#### Parameters
+
+• **this**: [`CreateBaseQueryResult`](CreateBaseQueryResult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\>
+
+#### Returns
+
+`this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"pending", TData, TError>>`
+
+#### 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<TData, TError, QueryObserverSuccessResult<TData, TError>>;
+```
+
+#### Parameters
+
+• **this**: [`CreateBaseQueryResult`](CreateBaseQueryResult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\>
+
+#### Returns
+
+`this is CreateBaseQueryResult<TData, TError, QueryObserverSuccessResult<TData, TError>>`
+
+#### 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
@@ -0,0 +1,32 @@
+---
+id: CreateBaseMutationResult
+title: CreateBaseMutationResult
+---
+
+# Type Alias: CreateBaseMutationResult\<TData, TError, TVariables, TContext\>
+
+```ts
+type CreateBaseMutationResult<TData, TError, TVariables, TContext>: Override<MutationObserverResult<TData, TError, TVariables, TContext>, object> & object;
+```
+
+## Type declaration
+
+### mutateAsync
+
+```ts
+mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
+```
+
+## 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
@@ -0,0 +1,22 @@
+---
+id: CreateBaseQueryOptions
+title: CreateBaseQueryOptions
+---
+
+# Interface: CreateBaseQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey\>
+
+## 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
@@ -0,0 +1,22 @@
+---
+id: CreateBaseQueryResult
+title: CreateBaseQueryResult
+---
+
+# Type Alias: CreateBaseQueryResult\<TData, TError, TState\>
+
+```ts
+type CreateBaseQueryResult<TData, TError, TState>: BaseQueryNarrowing<TData, TError> & MapToSignals<OmitKeyof<TState, keyof BaseQueryNarrowing, "safely">>;
+```
+
+## 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
@@ -0,0 +1,24 @@
+---
+id: CreateInfiniteQueryOptions
+title: CreateInfiniteQueryOptions
+---
+
+# Interface: CreateInfiniteQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam\>
+
+## 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
@@ -0,0 +1,20 @@
+---
+id: CreateInfiniteQueryResult
+title: CreateInfiniteQueryResult
+---
+
+# Type Alias: CreateInfiniteQueryResult\<TData, TError\>
+
+```ts
+type CreateInfiniteQueryResult<TData, TError>: MapToSignals<InfiniteQueryObserverResult<TData, TError>>;
+```
+
+## 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
@@ -0,0 +1,24 @@
+---
+id: CreateMutateAsyncFunction
+title: CreateMutateAsyncFunction
+---
+
+# Type Alias: CreateMutateAsyncFunction\<TData, TError, TVariables, TContext\>
+
+```ts
+type CreateMutateAsyncFunction<TData, TError, TVariables, TContext>: MutateFunction<TData, TError, TVariables, TContext>;
+```
+
+## 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
@@ -0,0 +1,32 @@
+---
+id: CreateMutateFunction
+title: CreateMutateFunction
+---
+
+# Type Alias: CreateMutateFunction()\<TData, TError, TVariables, TContext\>
+
+```ts
+type CreateMutateFunction<TData, TError, TVariables, TContext>: (...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
@@ -0,0 +1,20 @@
+---
+id: CreateMutationOptions
+title: CreateMutationOptions
+---
+
+# Interface: CreateMutationOptions\<TData, TError, TVariables, TContext\>
+
+## Extends
+
+- `OmitKeyof`\<`MutationObserverOptions`\<`TData`, `TError`, `TVariables`, `TContext`\>, `"_defaulted"`\>
+
+## Type Parameters
+
+• **TData** = `unknown`
+
+• **TError** = `DefaultError`
+
+• **TVariables** = `void`
+
+• **TContext** = `unknown`