Skip to content

Commit a34383e

Browse files
KyleAMathewsclaude
KyleAMathews
and
claude
authored
update generated docs & add CI job to fail PRs that need to re-run it (#758)
* update generated docs & add CI job to fail PRs that need to re-run it * Fix * Fix * fix again * run build first * Fix filename casing for case-sensitive filesystems Renamed 154 documentation files to match their proper PascalCase/camelCase names as generated by TypeDoc. This fixes CI failures on Linux where the filesystem is case-sensitive, while macOS allowed the mismatched casing. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> --------- Co-authored-by: Claude <[email protected]>
1 parent 75470a8 commit a34383e

File tree

453 files changed

+36680
-20690
lines changed

Some content is hidden

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

453 files changed

+36680
-20690
lines changed

‎.github/workflows/pr.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,25 @@ jobs:
9090
run: |
9191
cd examples/react/projects
9292
pnpm build
93+
check-docs:
94+
name: Check Generated Docs
95+
runs-on: ubuntu-latest
96+
steps:
97+
- name: Checkout
98+
uses: actions/[email protected]
99+
- name: Setup Tools
100+
uses: tanstack/config/.github/setup@main
101+
- name: Build Packages
102+
run: pnpm run build
103+
- name: Generate Docs
104+
run: pnpm docs:generate
105+
- name: Check for changes
106+
run: |
107+
if [ -n "$(git status --porcelain)" ]; then
108+
echo "Error: Generated docs are out of sync!"
109+
echo "Please run 'pnpm docs:generate' locally and commit the changes."
110+
echo ""
111+
echo "Files that need to be updated:"
112+
git status --short
113+
exit 1
114+
fi

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

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
id: injectLiveQuery
3+
title: injectLiveQuery
4+
---
5+
6+
# Function: injectLiveQuery()
7+
8+
## Call Signature
9+
10+
```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] }>;
12+
```
13+
14+
Defined in: [index.ts:51](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L51)
15+
16+
### Type Parameters
17+
18+
#### TContext
19+
20+
`TContext` *extends* `Context`
21+
22+
#### TParams
23+
24+
`TParams` *extends* `unknown`
25+
26+
### Parameters
27+
28+
#### options
29+
30+
##### params
31+
32+
() => `TParams`
33+
34+
##### query
35+
36+
(`args`) => `QueryBuilder`\<`TContext`\>
37+
38+
### Returns
39+
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\] \}\>
41+
42+
## Call Signature
43+
44+
```ts
45+
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] }>;
46+
```
47+
48+
Defined in: [index.ts:61](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L61)
49+
50+
### Type Parameters
51+
52+
#### TContext
53+
54+
`TContext` *extends* `Context`
55+
56+
### Parameters
57+
58+
#### queryFn
59+
60+
(`q`) => `QueryBuilder`\<`TContext`\>
61+
62+
### Returns
63+
64+
[`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\] \}\>
65+
66+
## Call Signature
67+
68+
```ts
69+
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] }>;
70+
```
71+
72+
Defined in: [index.ts:64](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L64)
73+
74+
### Type Parameters
75+
76+
#### TContext
77+
78+
`TContext` *extends* `Context`
79+
80+
### Parameters
81+
82+
#### config
83+
84+
`LiveQueryCollectionConfig`\<`TContext`\>
85+
86+
### Returns
87+
88+
[`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\] \}\>
89+
90+
## Call Signature
91+
92+
```ts
93+
function injectLiveQuery<TResult, TKey, TUtils>(liveQueryCollection): InjectLiveQueryResult<TResult, TKey, TUtils>;
94+
```
95+
96+
Defined in: [index.ts:67](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L67)
97+
98+
### Type Parameters
99+
100+
#### TResult
101+
102+
`TResult` *extends* `object`
103+
104+
#### TKey
105+
106+
`TKey` *extends* `string` \| `number`
107+
108+
#### TUtils
109+
110+
`TUtils` *extends* `Record`\<`string`, `any`\>
111+
112+
### Parameters
113+
114+
#### liveQueryCollection
115+
116+
`Collection`\<`TResult`, `TKey`, `TUtils`\>
117+
118+
### Returns
119+
120+
[`InjectLiveQueryResult`](../../interfaces/InjectLiveQueryResult.md)\<`TResult`, `TKey`, `TUtils`\>

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
id: "@tanstack/angular-db"
3+
title: "@tanstack/angular-db"
4+
---
5+
6+
# @tanstack/angular-db
7+
8+
## Interfaces
9+
10+
- [InjectLiveQueryResult](../interfaces/InjectLiveQueryResult.md)
11+
12+
## Functions
13+
14+
- [injectLiveQuery](../functions/injectLiveQuery.md)

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

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
id: InjectLiveQueryResult
3+
title: InjectLiveQueryResult
4+
---
5+
6+
# Interface: InjectLiveQueryResult\<TResult, TKey, TUtils\>
7+
8+
Defined in: [index.ts:26](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L26)
9+
10+
The result of calling `injectLiveQuery`.
11+
Contains reactive signals for the query state and data.
12+
13+
## Type Parameters
14+
15+
### TResult
16+
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+
\}
27+
28+
## Properties
29+
30+
### collection
31+
32+
```ts
33+
collection: Signal<Collection<TResult, TKey, TUtils, StandardSchemaV1<unknown, unknown>, TResult>>;
34+
```
35+
36+
Defined in: [index.ts:36](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L36)
37+
38+
A signal containing the underlying collection instance
39+
40+
***
41+
42+
### data
43+
44+
```ts
45+
data: Signal<TResult[]>;
46+
```
47+
48+
Defined in: [index.ts:34](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L34)
49+
50+
A signal containing the results as an array
51+
52+
***
53+
54+
### isCleanedUp
55+
56+
```ts
57+
isCleanedUp: Signal<boolean>;
58+
```
59+
60+
Defined in: [index.ts:48](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L48)
61+
62+
A signal indicating whether the collection has been cleaned up
63+
64+
***
65+
66+
### isError
67+
68+
```ts
69+
isError: Signal<boolean>;
70+
```
71+
72+
Defined in: [index.ts:46](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L46)
73+
74+
A signal indicating whether the collection has an error
75+
76+
***
77+
78+
### isIdle
79+
80+
```ts
81+
isIdle: Signal<boolean>;
82+
```
83+
84+
Defined in: [index.ts:44](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L44)
85+
86+
A signal indicating whether the collection is idle
87+
88+
***
89+
90+
### isLoading
91+
92+
```ts
93+
isLoading: Signal<boolean>;
94+
```
95+
96+
Defined in: [index.ts:40](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L40)
97+
98+
A signal indicating whether the collection is currently loading
99+
100+
***
101+
102+
### isReady
103+
104+
```ts
105+
isReady: Signal<boolean>;
106+
```
107+
108+
Defined in: [index.ts:42](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L42)
109+
110+
A signal indicating whether the collection is ready
111+
112+
***
113+
114+
### state
115+
116+
```ts
117+
state: Signal<Map<TKey, TResult>>;
118+
```
119+
120+
Defined in: [index.ts:32](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L32)
121+
122+
A signal containing the complete state map of results keyed by their ID
123+
124+
***
125+
126+
### status
127+
128+
```ts
129+
status: Signal<CollectionStatus>;
130+
```
131+
132+
Defined in: [index.ts:38](https://github.com/TanStack/db/blob/main/packages/angular-db/src/index.ts#L38)
133+
134+
A signal containing the current status of the collection

0 commit comments

Comments
 (0)