Skip to content

Commit 306ddd3

Browse files
KyleAMathewsclaude
andauthored
docs: Generate API reference documentation for core database classes and functions (#1286)
* fix: generate missing core db reference docs The db package's tsconfig.docs.json included "tests" in its include array, causing TypeScript errors that prevented TypeDoc from generating the core API reference documentation. Fixed by changing include to only "src" and adding explicit path mappings, consistent with all other package docs configs. https://claude.ai/code/session_0141NF2Zm7Q2GPt3CU8NKcNT * docs: regenerate reference docs for all packages Auto-generated output from running generate-docs script. Includes minor formatting updates to existing reference docs for framework and collection packages. https://claude.ai/code/session_0141NF2Zm7Q2GPt3CU8NKcNT --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 79c2aef commit 306ddd3

372 files changed

Lines changed: 39991 additions & 228 deletions

File tree

Some content is hidden

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

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: injectLiveQuery
1111
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] }>;
1212
```
1313

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

1616
### Type Parameters
1717

@@ -45,7 +45,7 @@ Defined in: [index.ts:51](https://github.com/TanStack/db/blob/main/packages/angu
4545
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] }>;
4646
```
4747

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

5050
### Type Parameters
5151

@@ -79,7 +79,7 @@ Defined in: [index.ts:61](https://github.com/TanStack/db/blob/main/packages/angu
7979
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] }>;
8080
```
8181

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

8484
### Type Parameters
8585

@@ -103,7 +103,7 @@ Defined in: [index.ts:71](https://github.com/TanStack/db/blob/main/packages/angu
103103
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] }>;
104104
```
105105

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

108108
### Type Parameters
109109

@@ -127,7 +127,7 @@ Defined in: [index.ts:74](https://github.com/TanStack/db/blob/main/packages/angu
127127
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] }>;
128128
```
129129

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

132132
### Type Parameters
133133

@@ -151,7 +151,7 @@ Defined in: [index.ts:79](https://github.com/TanStack/db/blob/main/packages/angu
151151
function injectLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): InjectLiveQueryResult<TResult, TKey, TUtils>;
152152
```
153153

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

156156
### Type Parameters
157157

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: InjectLiveQueryResult
55

66
# Interface: InjectLiveQueryResult\<TResult, TKey, TUtils\>
77

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

1010
The result of calling `injectLiveQuery`.
1111
Contains reactive signals for the query state and data.
@@ -35,7 +35,7 @@ collection: Signal<
3535
| null>;
3636
```
3737

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

4040
A signal containing the underlying collection instance (null for disabled queries)
4141

@@ -47,7 +47,7 @@ A signal containing the underlying collection instance (null for disabled querie
4747
data: Signal<TResult[]>;
4848
```
4949

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

5252
A signal containing the results as an array
5353

@@ -59,7 +59,7 @@ A signal containing the results as an array
5959
isCleanedUp: Signal<boolean>;
6060
```
6161

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

6464
A signal indicating whether the collection has been cleaned up
6565

@@ -71,7 +71,7 @@ A signal indicating whether the collection has been cleaned up
7171
isError: Signal<boolean>;
7272
```
7373

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

7676
A signal indicating whether the collection has an error
7777

@@ -83,7 +83,7 @@ A signal indicating whether the collection has an error
8383
isIdle: Signal<boolean>;
8484
```
8585

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

8888
A signal indicating whether the collection is idle
8989

@@ -95,7 +95,7 @@ A signal indicating whether the collection is idle
9595
isLoading: Signal<boolean>;
9696
```
9797

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

100100
A signal indicating whether the collection is currently loading
101101

@@ -107,7 +107,7 @@ A signal indicating whether the collection is currently loading
107107
isReady: Signal<boolean>;
108108
```
109109

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

112112
A signal indicating whether the collection is ready
113113

@@ -119,7 +119,7 @@ A signal indicating whether the collection is ready
119119
state: Signal<Map<TKey, TResult>>;
120120
```
121121

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

124124
A signal containing the complete state map of results keyed by their ID
125125

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

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

136136
A signal containing the current status of the collection

docs/framework/react/reference/functions/useLiveInfiniteQuery.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: useLiveInfiniteQuery
1111
function useLiveInfiniteQuery<TResult, TKey, TUtils>(liveQueryCollection, config): UseLiveInfiniteQueryReturn<any>;
1212
```
1313

14-
Defined in: [useLiveInfiniteQuery.ts:113](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L113)
14+
Defined in: useLiveInfiniteQuery.ts:113
1515

1616
Create an infinite query using a query function with live updates
1717

@@ -118,7 +118,7 @@ function useLiveInfiniteQuery<TContext>(
118118
deps?): UseLiveInfiniteQueryReturn<TContext>;
119119
```
120120

121-
Defined in: [useLiveInfiniteQuery.ts:123](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L123)
121+
Defined in: useLiveInfiniteQuery.ts:123
122122

123123
Create an infinite query using a query function with live updates
124124

docs/framework/react/reference/functions/useLiveQuery.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: useLiveQuery
1111
function useLiveQuery<TContext>(queryFn, deps?): object;
1212
```
1313

14-
Defined in: [useLiveQuery.ts:84](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L84)
14+
Defined in: useLiveQuery.ts:84
1515

1616
Create a live query using a query function
1717

@@ -168,7 +168,7 @@ return (
168168
function useLiveQuery<TContext>(queryFn, deps?): object;
169169
```
170170

171-
Defined in: [useLiveQuery.ts:101](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L101)
171+
Defined in: useLiveQuery.ts:101
172172

173173
Create a live query using a query function
174174

@@ -329,7 +329,7 @@ return (
329329
function useLiveQuery<TContext>(queryFn, deps?): object;
330330
```
331331

332-
Defined in: [useLiveQuery.ts:120](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L120)
332+
Defined in: useLiveQuery.ts:120
333333

334334
Create a live query using a query function
335335

@@ -493,7 +493,7 @@ return (
493493
function useLiveQuery<TResult, TKey, TUtils>(queryFn, deps?): object;
494494
```
495495

496-
Defined in: [useLiveQuery.ts:139](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L139)
496+
Defined in: useLiveQuery.ts:139
497497

498498
Create a live query using a query function
499499

@@ -662,7 +662,7 @@ return (
662662
function useLiveQuery<TContext, TResult, TKey, TUtils>(queryFn, deps?): object;
663663
```
664664

665-
Defined in: [useLiveQuery.ts:162](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L162)
665+
Defined in: useLiveQuery.ts:162
666666

667667
Create a live query using a query function
668668

@@ -842,7 +842,7 @@ return (
842842
function useLiveQuery<TContext>(config, deps?): object;
843843
```
844844

845-
Defined in: [useLiveQuery.ts:230](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L230)
845+
Defined in: useLiveQuery.ts:230
846846

847847
Create a live query using configuration object
848848

@@ -972,7 +972,7 @@ return <div>{data.length} items loaded</div>
972972
function useLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): object;
973973
```
974974

975-
Defined in: [useLiveQuery.ts:276](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L276)
975+
Defined in: useLiveQuery.ts:276
976976

977977
Subscribe to an existing live query collection
978978

@@ -1100,7 +1100,7 @@ return <div>{data.map(item => <Item key={item.id} {...item} />)}</div>
11001100
function useLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): object;
11011101
```
11021102

1103-
Defined in: [useLiveQuery.ts:296](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L296)
1103+
Defined in: useLiveQuery.ts:296
11041104

11051105
Create a live query using a query function
11061106

docs/framework/react/reference/functions/useLiveSuspenseQuery.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: useLiveSuspenseQuery
1111
function useLiveSuspenseQuery<TContext>(queryFn, deps?): object;
1212
```
1313

14-
Defined in: [useLiveSuspenseQuery.ts:109](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveSuspenseQuery.ts#L109)
14+
Defined in: useLiveSuspenseQuery.ts:109
1515

1616
Create a live query with React Suspense support
1717

@@ -167,7 +167,7 @@ const { data, isEnabled } = useLiveQuery(
167167
function useLiveSuspenseQuery<TContext>(config, deps?): object;
168168
```
169169

170-
Defined in: [useLiveSuspenseQuery.ts:119](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveSuspenseQuery.ts#L119)
170+
Defined in: useLiveSuspenseQuery.ts:119
171171

172172
Create a live query with React Suspense support
173173

@@ -321,7 +321,7 @@ const { data, isEnabled } = useLiveQuery(
321321
function useLiveSuspenseQuery<TResult, TKey, TUtils>(liveQueryCollection): object;
322322
```
323323

324-
Defined in: [useLiveSuspenseQuery.ts:129](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveSuspenseQuery.ts#L129)
324+
Defined in: useLiveSuspenseQuery.ts:129
325325

326326
Create a live query with React Suspense support
327327

@@ -476,7 +476,7 @@ const { data, isEnabled } = useLiveQuery(
476476
function useLiveSuspenseQuery<TResult, TKey, TUtils>(liveQueryCollection): object;
477477
```
478478

479-
Defined in: [useLiveSuspenseQuery.ts:142](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveSuspenseQuery.ts#L142)
479+
Defined in: useLiveSuspenseQuery.ts:142
480480

481481
Create a live query with React Suspense support
482482

docs/framework/react/reference/functions/usePacedMutations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: usePacedMutations
99
function usePacedMutations<TVariables, T>(config): (variables) => Transaction<T>;
1010
```
1111

12-
Defined in: [usePacedMutations.ts:93](https://github.com/TanStack/db/blob/main/packages/react-db/src/usePacedMutations.ts#L93)
12+
Defined in: usePacedMutations.ts:93
1313

1414
React hook for managing paced mutations with timing strategies.
1515

docs/framework/react/reference/type-aliases/UseLiveInfiniteQueryConfig.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: UseLiveInfiniteQueryConfig
99
type UseLiveInfiniteQueryConfig<TContext> = object;
1010
```
1111

12-
Defined in: [useLiveInfiniteQuery.ts:23](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L23)
12+
Defined in: useLiveInfiniteQuery.ts:23
1313

1414
## Type Parameters
1515

@@ -25,7 +25,7 @@ Defined in: [useLiveInfiniteQuery.ts:23](https://github.com/TanStack/db/blob/mai
2525
getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => number | undefined;
2626
```
2727

28-
Defined in: [useLiveInfiniteQuery.ts:26](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L26)
28+
Defined in: useLiveInfiniteQuery.ts:26
2929

3030
#### Parameters
3131

@@ -57,7 +57,7 @@ Defined in: [useLiveInfiniteQuery.ts:26](https://github.com/TanStack/db/blob/mai
5757
optional initialPageParam: number;
5858
```
5959

60-
Defined in: [useLiveInfiniteQuery.ts:25](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L25)
60+
Defined in: useLiveInfiniteQuery.ts:25
6161

6262
***
6363

@@ -67,4 +67,4 @@ Defined in: [useLiveInfiniteQuery.ts:25](https://github.com/TanStack/db/blob/mai
6767
optional pageSize: number;
6868
```
6969

70-
Defined in: [useLiveInfiniteQuery.ts:24](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L24)
70+
Defined in: useLiveInfiniteQuery.ts:24

docs/framework/react/reference/type-aliases/UseLiveInfiniteQueryReturn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: UseLiveInfiniteQueryReturn
99
type UseLiveInfiniteQueryReturn<TContext> = Omit<ReturnType<typeof useLiveQuery>, "data"> & object;
1010
```
1111

12-
Defined in: [useLiveInfiniteQuery.ts:34](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveInfiniteQuery.ts#L34)
12+
Defined in: useLiveInfiniteQuery.ts:34
1313

1414
## Type Declaration
1515

docs/framework/react/reference/type-aliases/UseLiveQueryStatus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ title: UseLiveQueryStatus
99
type UseLiveQueryStatus = CollectionStatus | "disabled";
1010
```
1111

12-
Defined in: [useLiveQuery.ts:23](https://github.com/TanStack/db/blob/main/packages/react-db/src/useLiveQuery.ts#L23)
12+
Defined in: useLiveQuery.ts:23

docs/framework/solid/reference/functions/useLiveQuery.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: useLiveQuery
1111
function useLiveQuery<TContext>(queryFn): Accessor<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }[]> & object;
1212
```
1313

14-
Defined in: [useLiveQuery.ts:98](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L98)
14+
Defined in: useLiveQuery.ts:98
1515

1616
Create a live query using a query function
1717

@@ -111,7 +111,7 @@ return (
111111
function useLiveQuery<TContext>(queryFn): Accessor<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }[]> & object;
112112
```
113113

114-
Defined in: [useLiveQuery.ts:117](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L117)
114+
Defined in: useLiveQuery.ts:117
115115

116116
Create a live query using a query function
117117

@@ -211,7 +211,7 @@ return (
211211
function useLiveQuery<TContext>(config): Accessor<{ [K in string | number | symbol]: (TContext["result"] extends object ? any[any] : TContext["hasJoins"] extends true ? TContext["schema"] : TContext["schema"][TContext["fromSourceName"]])[K] }[]> & object;
212212
```
213213

214-
Defined in: [useLiveQuery.ts:178](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L178)
214+
Defined in: useLiveQuery.ts:178
215215

216216
Create a live query using configuration object
217217

@@ -280,7 +280,7 @@ return (
280280
function useLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): Accessor<TResult[]> & object;
281281
```
282282

283-
Defined in: [useLiveQuery.ts:232](https://github.com/TanStack/db/blob/main/packages/solid-db/src/useLiveQuery.ts#L232)
283+
Defined in: useLiveQuery.ts:232
284284

285285
Subscribe to an existing live query collection
286286

0 commit comments

Comments
 (0)