Skip to content

Commit 49c9374

Browse files
github-actions[bot]github-actions[bot]
authored
docs: regenerate API documentation (#1292)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent f61d903 commit 49c9374

File tree

374 files changed

+1487
-1231
lines changed

Some content is hidden

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

374 files changed

+1487
-1231
lines changed

‎docs/framework/angular/reference/functions/injectLiveQuery.md‎

Lines changed: 51 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ title: injectLiveQuery
88
## Call Signature
99

1010
```ts
11-
function injectLiveQuery<TContext, TParams>(options): InjectLiveQueryResult<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;
11+
function injectLiveQuery<TContext, TParams>(options): InjectLiveQueryResult<TContext>;
1212
```
1313

14-
Defined in: index.ts:51
14+
Defined in: [index.ts:87](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L87)
1515

1616
### Type Parameters
1717

@@ -37,15 +37,15 @@ Defined in: index.ts:51
3737

3838
### Returns
3939

40-
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
40+
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<`TContext`\>
4141

4242
## Call Signature
4343

4444
```ts
45-
function injectLiveQuery<TContext, TParams>(options): InjectLiveQueryResult<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;
45+
function injectLiveQuery<TContext, TParams>(options): InjectLiveQueryResult<TContext>;
4646
```
4747

48-
Defined in: index.ts:61
48+
Defined in: [index.ts:97](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L97)
4949

5050
### Type Parameters
5151

@@ -71,15 +71,15 @@ Defined in: index.ts:61
7171

7272
### Returns
7373

74-
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
74+
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<`TContext`\>
7575

7676
## Call Signature
7777

7878
```ts
79-
function injectLiveQuery<TContext>(queryFn): InjectLiveQueryResult<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;
79+
function injectLiveQuery<TContext>(queryFn): InjectLiveQueryResult<TContext>;
8080
```
8181

82-
Defined in: index.ts:71
82+
Defined in: [index.ts:107](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L107)
8383

8484
### Type Parameters
8585

@@ -95,15 +95,15 @@ Defined in: index.ts:71
9595

9696
### Returns
9797

98-
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
98+
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<`TContext`\>
9999

100100
## Call Signature
101101

102102
```ts
103-
function injectLiveQuery<TContext>(queryFn): InjectLiveQueryResult<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;
103+
function injectLiveQuery<TContext>(queryFn): InjectLiveQueryResult<TContext>;
104104
```
105105

106-
Defined in: index.ts:74
106+
Defined in: [index.ts:110](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L110)
107107

108108
### Type Parameters
109109

@@ -119,15 +119,15 @@ Defined in: index.ts:74
119119

120120
### Returns
121121

122-
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
122+
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<`TContext`\>
123123

124124
## Call Signature
125125

126126
```ts
127-
function injectLiveQuery<TContext>(config): InjectLiveQueryResult<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>;
127+
function injectLiveQuery<TContext>(config): InjectLiveQueryResult<TContext>;
128128
```
129129

130-
Defined in: index.ts:79
130+
Defined in: [index.ts:115](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L115)
131131

132132
### Type Parameters
133133

@@ -143,15 +143,15 @@ Defined in: index.ts:79
143143

144144
### Returns
145145

146-
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<\{ \[K in string \| number \| symbol\]: (TContext\["result"\] extends object ? any\[any\] : TContext\["hasJoins"\] extends true ? TContext\["schema"\] : TContext\["schema"\]\[TContext\["fromSourceName"\]\])\[K\] \}\>
146+
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<`TContext`\>
147147

148148
## Call Signature
149149

150150
```ts
151-
function injectLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): InjectLiveQueryResult<TResult, TKey, TUtils>;
151+
function injectLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): InjectLiveQueryResultWithCollection<TResult, TKey, TUtils>;
152152
```
153153

154-
Defined in: index.ts:82
154+
Defined in: [index.ts:119](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L119)
155155

156156
### Type Parameters
157157

@@ -171,8 +171,40 @@ Defined in: index.ts:82
171171

172172
#### liveQueryCollection
173173

174-
`Collection`\<`TResult`, `TKey`, `TUtils`\>
174+
`Collection`\<`TResult`, `TKey`, `TUtils`, `StandardSchemaV1`\<`unknown`, `unknown`\>, `TResult`\> & `NonSingleResult`
175175

176176
### Returns
177177

178-
[`InjectLiveQueryResult`](../interfaces/InjectLiveQueryResult.md)\<`TResult`, `TKey`, `TUtils`\>
178+
[`InjectLiveQueryResultWithCollection`](../interfaces/InjectLiveQueryResultWithCollection.md)\<`TResult`, `TKey`, `TUtils`\>
179+
180+
## Call Signature
181+
182+
```ts
183+
function injectLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): InjectLiveQueryResultWithSingleResultCollection<TResult, TKey, TUtils>;
184+
```
185+
186+
Defined in: [index.ts:127](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L127)
187+
188+
### Type Parameters
189+
190+
#### TResult
191+
192+
`TResult` *extends* `object`
193+
194+
#### TKey
195+
196+
`TKey` *extends* `string` \| `number`
197+
198+
#### TUtils
199+
200+
`TUtils` *extends* `Record`\<`string`, `any`\>
201+
202+
### Parameters
203+
204+
#### liveQueryCollection
205+
206+
`Collection`\<`TResult`, `TKey`, `TUtils`, `StandardSchemaV1`\<`unknown`, `unknown`\>, `TResult`\> & `SingleResult`
207+
208+
### Returns
209+
210+
[`InjectLiveQueryResultWithSingleResultCollection`](../interfaces/InjectLiveQueryResultWithSingleResultCollection.md)\<`TResult`, `TKey`, `TUtils`\>

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ title: "@tanstack/angular-db"
88
## Interfaces
99

1010
- [InjectLiveQueryResult](interfaces/InjectLiveQueryResult.md)
11+
- [InjectLiveQueryResultWithCollection](interfaces/InjectLiveQueryResultWithCollection.md)
12+
- [InjectLiveQueryResultWithSingleResultCollection](interfaces/InjectLiveQueryResultWithSingleResultCollection.md)
1113

1214
## Functions
1315

‎docs/framework/angular/reference/interfaces/InjectLiveQueryResult.md‎

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,31 @@ id: InjectLiveQueryResult
33
title: InjectLiveQueryResult
44
---
55

6-
# Interface: InjectLiveQueryResult\<TResult, TKey, TUtils\>
6+
# Interface: InjectLiveQueryResult\<TContext\>
77

8-
Defined in: index.ts:26
8+
Defined in: [index.ts:30](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L30)
99

1010
The result of calling `injectLiveQuery`.
1111
Contains reactive signals for the query state and data.
1212

1313
## Type Parameters
1414

15-
### TResult
15+
### TContext
1616

17-
`TResult` *extends* `object` = `any`
18-
19-
### TKey
20-
21-
`TKey` *extends* `string` \| `number` = `string` \| `number`
22-
23-
### TUtils
24-
25-
`TUtils` *extends* `Record`\<`string`, `any`\> = \{
26-
\}
17+
`TContext` *extends* `Context`
2718

2819
## Properties
2920

3021
### collection
3122

3223
```ts
3324
collection: Signal<
34-
| Collection<TResult, TKey, TUtils, StandardSchemaV1<unknown, unknown>, TResult>
25+
| Collection<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }, string | number, {
26+
}, StandardSchemaV1<unknown, unknown>, { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>
3527
| null>;
3628
```
3729

38-
Defined in: index.ts:36
30+
Defined in: [index.ts:36](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L36)
3931

4032
A signal containing the underlying collection instance (null for disabled queries)
4133

@@ -44,12 +36,12 @@ A signal containing the underlying collection instance (null for disabled querie
4436
### data
4537

4638
```ts
47-
data: Signal<TResult[]>;
39+
data: Signal<InferResultType<TContext>>;
4840
```
4941

50-
Defined in: index.ts:34
42+
Defined in: [index.ts:34](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L34)
5143

52-
A signal containing the results as an array
44+
A signal containing the results as an array, or single result for findOne queries
5345

5446
***
5547

@@ -59,7 +51,7 @@ A signal containing the results as an array
5951
isCleanedUp: Signal<boolean>;
6052
```
6153

62-
Defined in: index.ts:48
54+
Defined in: [index.ts:52](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L52)
6355

6456
A signal indicating whether the collection has been cleaned up
6557

@@ -71,7 +63,7 @@ A signal indicating whether the collection has been cleaned up
7163
isError: Signal<boolean>;
7264
```
7365

74-
Defined in: index.ts:46
66+
Defined in: [index.ts:50](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L50)
7567

7668
A signal indicating whether the collection has an error
7769

@@ -83,7 +75,7 @@ A signal indicating whether the collection has an error
8375
isIdle: Signal<boolean>;
8476
```
8577

86-
Defined in: index.ts:44
78+
Defined in: [index.ts:48](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L48)
8779

8880
A signal indicating whether the collection is idle
8981

@@ -95,7 +87,7 @@ A signal indicating whether the collection is idle
9587
isLoading: Signal<boolean>;
9688
```
9789

98-
Defined in: index.ts:40
90+
Defined in: [index.ts:44](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L44)
9991

10092
A signal indicating whether the collection is currently loading
10193

@@ -107,7 +99,7 @@ A signal indicating whether the collection is currently loading
10799
isReady: Signal<boolean>;
108100
```
109101

110-
Defined in: index.ts:42
102+
Defined in: [index.ts:46](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L46)
111103

112104
A signal indicating whether the collection is ready
113105

@@ -116,10 +108,10 @@ A signal indicating whether the collection is ready
116108
### state
117109

118110
```ts
119-
state: Signal<Map<TKey, TResult>>;
111+
state: Signal<Map<string | number, { [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }>>;
120112
```
121113

122-
Defined in: index.ts:32
114+
Defined in: [index.ts:32](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L32)
123115

124116
A signal containing the complete state map of results keyed by their ID
125117

@@ -131,6 +123,6 @@ A signal containing the complete state map of results keyed by their ID
131123
status: Signal<CollectionStatus | "disabled">;
132124
```
133125

134-
Defined in: index.ts:38
126+
Defined in: [index.ts:42](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L42)
135127

136128
A signal containing the current status of the collection

0 commit comments

Comments
 (0)