Skip to content

Commit 144d3a8

Browse files
lachlancollinslachlancollins
authored
docs(typedoc): Update output filename (#7764)
* docs: Update typedoc output filename * Run prettier
1 parent 2786196 commit 144d3a8

File tree

76 files changed

+1915
-94
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+1915
-94
lines changed

‎docs/config.json

+11-2
Original file line numberDiff line numberDiff line change
@@ -747,11 +747,20 @@
747747
},
748748
{
749749
"label": "Functions / createQuery",
750-
"to": "framework/svelte/reference/createquery"
750+
"to": "framework/svelte/reference/createQuery"
751751
},
752752
{
753753
"label": "Functions / createMutation",
754-
"to": "framework/svelte/reference/createmutation"
754+
"to": "framework/svelte/reference/createMutation"
755+
}
756+
]
757+
},
758+
{
759+
"label": "angular",
760+
"children": [
761+
{
762+
"label": "Angular Reference",
763+
"to": "framework/angular/reference/index"
755764
}
756765
]
757766
}

‎docs/framework/angular/reference/BaseMutationNarrowing.md

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
id: BaseMutationNarrowing
3+
title: BaseMutationNarrowing
4+
---
5+
6+
# Interface: BaseMutationNarrowing\<TData, TError, TVariables, TContext\>
7+
8+
## Type Parameters
9+
10+
• **TData** = `unknown`
11+
12+
• **TError** = `DefaultError`
13+
14+
• **TVariables** = `unknown`
15+
16+
• **TContext** = `unknown`
17+
18+
## Properties
19+
20+
### isError()
21+
22+
```ts
23+
isError: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverErrorResult<TData, TError, TVariables, TContext>, Object> & Object>;
24+
```
25+
26+
#### Parameters
27+
28+
• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\>
29+
30+
#### Returns
31+
32+
`this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverErrorResult<TData, TError, TVariables, TContext>, Object> & Object>`
33+
34+
#### Defined in
35+
36+
[types.ts:248](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L248)
37+
38+
---
39+
40+
### isIdle()
41+
42+
```ts
43+
isIdle: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverIdleResult<TData, TError, TVariables, TContext>, Object> & Object>;
44+
```
45+
46+
#### Parameters
47+
48+
• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\>
49+
50+
#### Returns
51+
52+
`this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverIdleResult<TData, TError, TVariables, TContext>, Object> & Object>`
53+
54+
#### Defined in
55+
56+
[types.ts:278](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L278)
57+
58+
---
59+
60+
### isPending()
61+
62+
```ts
63+
isPending: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverLoadingResult<TData, TError, TVariables, TContext>, Object> & Object>;
64+
```
65+
66+
#### Parameters
67+
68+
• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\>
69+
70+
#### Returns
71+
72+
`this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverLoadingResult<TData, TError, TVariables, TContext>, Object> & Object>`
73+
74+
#### Defined in
75+
76+
[types.ts:263](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L263)
77+
78+
---
79+
80+
### isSuccess()
81+
82+
```ts
83+
isSuccess: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverSuccessResult<TData, TError, TVariables, TContext>, Object> & Object>;
84+
```
85+
86+
#### Parameters
87+
88+
• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\>
89+
90+
#### Returns
91+
92+
`this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverSuccessResult<TData, TError, TVariables, TContext>, Object> & Object>`
93+
94+
#### Defined in
95+
96+
[types.ts:233](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L233)

‎docs/framework/angular/reference/BaseQueryNarrowing.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
id: BaseQueryNarrowing
3+
title: BaseQueryNarrowing
4+
---
5+
6+
# Interface: BaseQueryNarrowing\<TData, TError\>
7+
8+
## Type Parameters
9+
10+
• **TData** = `unknown`
11+
12+
• **TError** = `DefaultError`
13+
14+
## Properties
15+
16+
### isError()
17+
18+
```ts
19+
isError: (this) => this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"error", TData, TError>>;
20+
```
21+
22+
#### Parameters
23+
24+
• **this**: [`CreateBaseQueryResult`](CreateBaseQueryResult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\>
25+
26+
#### Returns
27+
28+
`this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"error", TData, TError>>`
29+
30+
#### Defined in
31+
32+
[types.ts:75](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L75)
33+
34+
---
35+
36+
### isPending()
37+
38+
```ts
39+
isPending: (this) => this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"pending", TData, TError>>;
40+
```
41+
42+
#### Parameters
43+
44+
• **this**: [`CreateBaseQueryResult`](CreateBaseQueryResult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\>
45+
46+
#### Returns
47+
48+
`this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"pending", TData, TError>>`
49+
50+
#### Defined in
51+
52+
[types.ts:82](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L82)
53+
54+
---
55+
56+
### isSuccess()
57+
58+
```ts
59+
isSuccess: (this) => this is CreateBaseQueryResult<TData, TError, QueryObserverSuccessResult<TData, TError>>;
60+
```
61+
62+
#### Parameters
63+
64+
• **this**: [`CreateBaseQueryResult`](CreateBaseQueryResult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\>
65+
66+
#### Returns
67+
68+
`this is CreateBaseQueryResult<TData, TError, QueryObserverSuccessResult<TData, TError>>`
69+
70+
#### Defined in
71+
72+
[types.ts:68](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L68)

‎docs/framework/angular/reference/CreateBaseMutationResult.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
id: CreateBaseMutationResult
3+
title: CreateBaseMutationResult
4+
---
5+
6+
# Type Alias: CreateBaseMutationResult\<TData, TError, TVariables, TContext\>
7+
8+
```ts
9+
type CreateBaseMutationResult<TData, TError, TVariables, TContext>: Override<MutationObserverResult<TData, TError, TVariables, TContext>, object> & object;
10+
```
11+
12+
## Type declaration
13+
14+
### mutateAsync
15+
16+
```ts
17+
mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
18+
```
19+
20+
## Type Parameters
21+
22+
• **TData** = `unknown`
23+
24+
• **TError** = `DefaultError`
25+
26+
• **TVariables** = `unknown`
27+
28+
• **TContext** = `unknown`
29+
30+
## Defined in
31+
32+
[types.ts:198](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L198)

‎docs/framework/angular/reference/CreateBaseQueryOptions.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
id: CreateBaseQueryOptions
3+
title: CreateBaseQueryOptions
4+
---
5+
6+
# Interface: CreateBaseQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey\>
7+
8+
## Extends
9+
10+
- `QueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\>
11+
12+
## Type Parameters
13+
14+
• **TQueryFnData** = `unknown`
15+
16+
• **TError** = `DefaultError`
17+
18+
• **TData** = `TQueryFnData`
19+
20+
• **TQueryData** = `TQueryFnData`
21+
22+
• **TQueryKey** _extends_ `QueryKey` = `QueryKey`

‎docs/framework/angular/reference/CreateBaseQueryResult.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
id: CreateBaseQueryResult
3+
title: CreateBaseQueryResult
4+
---
5+
6+
# Type Alias: CreateBaseQueryResult\<TData, TError, TState\>
7+
8+
```ts
9+
type CreateBaseQueryResult<TData, TError, TState>: BaseQueryNarrowing<TData, TError> & MapToSignals<OmitKeyof<TState, keyof BaseQueryNarrowing, "safely">>;
10+
```
11+
12+
## Type Parameters
13+
14+
• **TData** = `unknown`
15+
16+
• **TError** = `DefaultError`
17+
18+
• **TState** = `QueryObserverResult`\<`TData`, `TError`\>
19+
20+
## Defined in
21+
22+
[types.ts:116](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L116)

‎docs/framework/angular/reference/CreateInfiniteQueryOptions.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
id: CreateInfiniteQueryOptions
3+
title: CreateInfiniteQueryOptions
4+
---
5+
6+
# Interface: CreateInfiniteQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam\>
7+
8+
## Extends
9+
10+
- `OmitKeyof`\<`InfiniteQueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`, `TPageParam`\>, `"suspense"`\>
11+
12+
## Type Parameters
13+
14+
• **TQueryFnData** = `unknown`
15+
16+
• **TError** = `DefaultError`
17+
18+
• **TData** = `TQueryFnData`
19+
20+
• **TQueryData** = `TQueryFnData`
21+
22+
• **TQueryKey** _extends_ `QueryKey` = `QueryKey`
23+
24+
• **TPageParam** = `unknown`

‎docs/framework/angular/reference/CreateInfiniteQueryResult.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
id: CreateInfiniteQueryResult
3+
title: CreateInfiniteQueryResult
4+
---
5+
6+
# Type Alias: CreateInfiniteQueryResult\<TData, TError\>
7+
8+
```ts
9+
type CreateInfiniteQueryResult<TData, TError>: MapToSignals<InfiniteQueryObserverResult<TData, TError>>;
10+
```
11+
12+
## Type Parameters
13+
14+
• **TData** = `unknown`
15+
16+
• **TError** = `DefaultError`
17+
18+
## Defined in
19+
20+
[types.ts:143](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L143)

‎docs/framework/angular/reference/CreateMutateAsyncFunction.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
id: CreateMutateAsyncFunction
3+
title: CreateMutateAsyncFunction
4+
---
5+
6+
# Type Alias: CreateMutateAsyncFunction\<TData, TError, TVariables, TContext\>
7+
8+
```ts
9+
type CreateMutateAsyncFunction<TData, TError, TVariables, TContext>: MutateFunction<TData, TError, TVariables, TContext>;
10+
```
11+
12+
## Type Parameters
13+
14+
• **TData** = `unknown`
15+
16+
• **TError** = `DefaultError`
17+
18+
• **TVariables** = `void`
19+
20+
• **TContext** = `unknown`
21+
22+
## Defined in
23+
24+
[types.ts:188](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L188)

‎docs/framework/angular/reference/CreateMutateFunction.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
id: CreateMutateFunction
3+
title: CreateMutateFunction
4+
---
5+
6+
# Type Alias: CreateMutateFunction()\<TData, TError, TVariables, TContext\>
7+
8+
```ts
9+
type CreateMutateFunction<TData, TError, TVariables, TContext>: (...args) => void;
10+
```
11+
12+
## Type Parameters
13+
14+
• **TData** = `unknown`
15+
16+
• **TError** = `DefaultError`
17+
18+
• **TVariables** = `void`
19+
20+
• **TContext** = `unknown`
21+
22+
## Parameters
23+
24+
• ...**args**: `Parameters`\<`MutateFunction`\<`TData`, `TError`, `TVariables`, `TContext`\>\>
25+
26+
## Returns
27+
28+
`void`
29+
30+
## Defined in
31+
32+
[types.ts:176](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L176)

‎docs/framework/angular/reference/CreateMutationOptions.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
id: CreateMutationOptions
3+
title: CreateMutationOptions
4+
---
5+
6+
# Interface: CreateMutationOptions\<TData, TError, TVariables, TContext\>
7+
8+
## Extends
9+
10+
- `OmitKeyof`\<`MutationObserverOptions`\<`TData`, `TError`, `TVariables`, `TContext`\>, `"_defaulted"`\>
11+
12+
## Type Parameters
13+
14+
• **TData** = `unknown`
15+
16+
• **TError** = `DefaultError`
17+
18+
• **TVariables** = `void`
19+
20+
• **TContext** = `unknown`

0 commit comments

Comments
 (0)