Skip to content

Commit a452ca7

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

File tree

58 files changed

+470
-122
lines changed

Some content is hidden

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

58 files changed

+470
-122
lines changed

docs/reference/classes/AggregateFunctionNotInSelectError.md

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

66
# Class: AggregateFunctionNotInSelectError
77

8-
Defined in: [packages/db/src/errors.ts:594](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L594)
8+
Defined in: [packages/db/src/errors.ts:605](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L605)
99

1010
## Extends
1111

@@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:594](https://github.com/TanStack/db/blob/
1919
new AggregateFunctionNotInSelectError(functionName): AggregateFunctionNotInSelectError;
2020
```
2121

22-
Defined in: [packages/db/src/errors.ts:595](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L595)
22+
Defined in: [packages/db/src/errors.ts:606](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L606)
2323

2424
#### Parameters
2525

docs/reference/classes/AggregateNotSupportedError.md

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

66
# Class: AggregateNotSupportedError
77

8-
Defined in: [packages/db/src/errors.ts:710](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L710)
8+
Defined in: [packages/db/src/errors.ts:721](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L721)
99

1010
Error thrown when aggregate expressions are used outside of a GROUP BY context.
1111

@@ -21,7 +21,7 @@ Error thrown when aggregate expressions are used outside of a GROUP BY context.
2121
new AggregateNotSupportedError(): AggregateNotSupportedError;
2222
```
2323

24-
Defined in: [packages/db/src/errors.ts:711](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L711)
24+
Defined in: [packages/db/src/errors.ts:722](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L722)
2525

2626
#### Returns
2727

docs/reference/classes/CannotCombineEmptyExpressionListError.md

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

66
# Class: CannotCombineEmptyExpressionListError
77

8-
Defined in: [packages/db/src/errors.ts:673](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L673)
8+
Defined in: [packages/db/src/errors.ts:684](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L684)
99

1010
## Extends
1111

@@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:673](https://github.com/TanStack/db/blob/
1919
new CannotCombineEmptyExpressionListError(): CannotCombineEmptyExpressionListError;
2020
```
2121

22-
Defined in: [packages/db/src/errors.ts:674](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L674)
22+
Defined in: [packages/db/src/errors.ts:685](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L685)
2323

2424
#### Returns
2525

docs/reference/classes/CollectionInputNotFoundError.md

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

66
# Class: CollectionInputNotFoundError
77

8-
Defined in: [packages/db/src/errors.ts:454](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L454)
8+
Defined in: [packages/db/src/errors.ts:465](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L465)
99

1010
Error thrown when a collection input stream is not found during query compilation.
1111
In self-joins, each alias (e.g., 'employee', 'manager') requires its own input stream.
@@ -25,7 +25,7 @@ new CollectionInputNotFoundError(
2525
availableKeys?): CollectionInputNotFoundError;
2626
```
2727
28-
Defined in: [packages/db/src/errors.ts:455](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L455)
28+
Defined in: [packages/db/src/errors.ts:466](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L466)
2929
3030
#### Parameters
3131

docs/reference/classes/DeduplicatedLoadSubset.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ true if data is already loaded, or a Promise that resolves when data is loaded
106106
reset(): void;
107107
```
108108

109-
Defined in: [packages/db/src/query/subset-dedupe.ts:198](https://github.com/TanStack/db/blob/main/packages/db/src/query/subset-dedupe.ts#L198)
109+
Defined in: [packages/db/src/query/subset-dedupe.ts:197](https://github.com/TanStack/db/blob/main/packages/db/src/query/subset-dedupe.ts#L197)
110110

111111
Reset all tracking state.
112112
Clears the history of loaded predicates and in-flight calls.

docs/reference/classes/DuplicateAliasInSubqueryError.md

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

66
# Class: DuplicateAliasInSubqueryError
77

8-
Defined in: [packages/db/src/errors.ts:475](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L475)
8+
Defined in: [packages/db/src/errors.ts:486](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L486)
99

1010
Error thrown when a subquery uses the same alias as its parent query.
1111
This causes issues because parent and subquery would share the same input streams,
@@ -23,7 +23,7 @@ leading to empty results or incorrect data (aggregation cross-leaking).
2323
new DuplicateAliasInSubqueryError(alias, parentAliases): DuplicateAliasInSubqueryError;
2424
```
2525

26-
Defined in: [packages/db/src/errors.ts:476](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L476)
26+
Defined in: [packages/db/src/errors.ts:487](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L487)
2727

2828
#### Parameters
2929

docs/reference/classes/EmptyReferencePathError.md

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

66
# Class: EmptyReferencePathError
77

8-
Defined in: [packages/db/src/errors.ts:498](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L498)
8+
Defined in: [packages/db/src/errors.ts:509](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L509)
99

1010
## Extends
1111

@@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:498](https://github.com/TanStack/db/blob/
1919
new EmptyReferencePathError(): EmptyReferencePathError;
2020
```
2121

22-
Defined in: [packages/db/src/errors.ts:499](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L499)
22+
Defined in: [packages/db/src/errors.ts:510](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L510)
2323

2424
#### Returns
2525

Lines changed: 214 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
---
2+
id: FnSelectWithGroupByError
3+
title: FnSelectWithGroupByError
4+
---
5+
6+
# Class: FnSelectWithGroupByError
7+
8+
Defined in: [packages/db/src/errors.ts:436](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L436)
9+
10+
## Extends
11+
12+
- [`QueryCompilationError`](QueryCompilationError.md)
13+
14+
## Constructors
15+
16+
### Constructor
17+
18+
```ts
19+
new FnSelectWithGroupByError(): FnSelectWithGroupByError;
20+
```
21+
22+
Defined in: [packages/db/src/errors.ts:437](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L437)
23+
24+
#### Returns
25+
26+
`FnSelectWithGroupByError`
27+
28+
#### Overrides
29+
30+
[`QueryCompilationError`](QueryCompilationError.md).[`constructor`](QueryCompilationError.md#constructor)
31+
32+
## Properties
33+
34+
### cause?
35+
36+
```ts
37+
optional cause: unknown;
38+
```
39+
40+
Defined in: node\_modules/.pnpm/[email protected]/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
41+
42+
#### Inherited from
43+
44+
[`QueryCompilationError`](QueryCompilationError.md).[`cause`](QueryCompilationError.md#cause)
45+
46+
***
47+
48+
### message
49+
50+
```ts
51+
message: string;
52+
```
53+
54+
Defined in: node\_modules/.pnpm/[email protected]/node\_modules/typescript/lib/lib.es5.d.ts:1077
55+
56+
#### Inherited from
57+
58+
[`QueryCompilationError`](QueryCompilationError.md).[`message`](QueryCompilationError.md#message)
59+
60+
***
61+
62+
### name
63+
64+
```ts
65+
name: string;
66+
```
67+
68+
Defined in: node\_modules/.pnpm/[email protected]/node\_modules/typescript/lib/lib.es5.d.ts:1076
69+
70+
#### Inherited from
71+
72+
[`QueryCompilationError`](QueryCompilationError.md).[`name`](QueryCompilationError.md#name)
73+
74+
***
75+
76+
### stack?
77+
78+
```ts
79+
optional stack: string;
80+
```
81+
82+
Defined in: node\_modules/.pnpm/[email protected]/node\_modules/typescript/lib/lib.es5.d.ts:1078
83+
84+
#### Inherited from
85+
86+
[`QueryCompilationError`](QueryCompilationError.md).[`stack`](QueryCompilationError.md#stack)
87+
88+
***
89+
90+
### stackTraceLimit
91+
92+
```ts
93+
static stackTraceLimit: number;
94+
```
95+
96+
Defined in: node\_modules/.pnpm/@types[email protected]/node\_modules/@types/node/globals.d.ts:67
97+
98+
The `Error.stackTraceLimit` property specifies the number of stack frames
99+
collected by a stack trace (whether generated by `new Error().stack` or
100+
`Error.captureStackTrace(obj)`).
101+
102+
The default value is `10` but may be set to any valid JavaScript number. Changes
103+
will affect any stack trace captured _after_ the value has been changed.
104+
105+
If set to a non-number value, or set to a negative number, stack traces will
106+
not capture any frames.
107+
108+
#### Inherited from
109+
110+
[`QueryCompilationError`](QueryCompilationError.md).[`stackTraceLimit`](QueryCompilationError.md#stacktracelimit)
111+
112+
## Methods
113+
114+
### captureStackTrace()
115+
116+
```ts
117+
static captureStackTrace(targetObject, constructorOpt?): void;
118+
```
119+
120+
Defined in: node\_modules/.pnpm/@[email protected]/node\_modules/@types/node/globals.d.ts:51
121+
122+
Creates a `.stack` property on `targetObject`, which when accessed returns
123+
a string representing the location in the code at which
124+
`Error.captureStackTrace()` was called.
125+
126+
```js
127+
const myObject = {};
128+
Error.captureStackTrace(myObject);
129+
myObject.stack; // Similar to `new Error().stack`
130+
```
131+
132+
The first line of the trace will be prefixed with
133+
`${myObject.name}: ${myObject.message}`.
134+
135+
The optional `constructorOpt` argument accepts a function. If given, all frames
136+
above `constructorOpt`, including `constructorOpt`, will be omitted from the
137+
generated stack trace.
138+
139+
The `constructorOpt` argument is useful for hiding implementation
140+
details of error generation from the user. For instance:
141+
142+
```js
143+
function a() {
144+
b();
145+
}
146+
147+
function b() {
148+
c();
149+
}
150+
151+
function c() {
152+
// Create an error without stack trace to avoid calculating the stack trace twice.
153+
const { stackTraceLimit } = Error;
154+
Error.stackTraceLimit = 0;
155+
const error = new Error();
156+
Error.stackTraceLimit = stackTraceLimit;
157+
158+
// Capture the stack trace above function b
159+
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
160+
throw error;
161+
}
162+
163+
a();
164+
```
165+
166+
#### Parameters
167+
168+
##### targetObject
169+
170+
`object`
171+
172+
##### constructorOpt?
173+
174+
`Function`
175+
176+
#### Returns
177+
178+
`void`
179+
180+
#### Inherited from
181+
182+
[`QueryCompilationError`](QueryCompilationError.md).[`captureStackTrace`](QueryCompilationError.md#capturestacktrace)
183+
184+
***
185+
186+
### prepareStackTrace()
187+
188+
```ts
189+
static prepareStackTrace(err, stackTraces): any;
190+
```
191+
192+
Defined in: node\_modules/.pnpm/@[email protected]/node\_modules/@types/node/globals.d.ts:55
193+
194+
#### Parameters
195+
196+
##### err
197+
198+
`Error`
199+
200+
##### stackTraces
201+
202+
`CallSite`[]
203+
204+
#### Returns
205+
206+
`any`
207+
208+
#### See
209+
210+
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
211+
212+
#### Inherited from
213+
214+
[`QueryCompilationError`](QueryCompilationError.md).[`prepareStackTrace`](QueryCompilationError.md#preparestacktrace)

docs/reference/classes/GroupByError.md

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

66
# Class: GroupByError
77

8-
Defined in: [packages/db/src/errors.ts:573](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L573)
8+
Defined in: [packages/db/src/errors.ts:584](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L584)
99

1010
## Extends
1111

@@ -26,7 +26,7 @@ Defined in: [packages/db/src/errors.ts:573](https://github.com/TanStack/db/blob/
2626
new GroupByError(message): GroupByError;
2727
```
2828

29-
Defined in: [packages/db/src/errors.ts:574](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L574)
29+
Defined in: [packages/db/src/errors.ts:585](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L585)
3030

3131
#### Parameters
3232

docs/reference/classes/HavingRequiresGroupByError.md

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

66
# Class: HavingRequiresGroupByError
77

8-
Defined in: [packages/db/src/errors.ts:436](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L436)
8+
Defined in: [packages/db/src/errors.ts:447](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L447)
99

1010
## Extends
1111

@@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:436](https://github.com/TanStack/db/blob/
1919
new HavingRequiresGroupByError(): HavingRequiresGroupByError;
2020
```
2121

22-
Defined in: [packages/db/src/errors.ts:437](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L437)
22+
Defined in: [packages/db/src/errors.ts:448](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L448)
2323

2424
#### Returns
2525

0 commit comments

Comments
 (0)