Skip to content

Commit 75e838d

Browse files
KyleAMathewsKyleAMathews
committed
docs: regenerate API documentation
1 parent 9290765 commit 75e838d

66 files changed

Lines changed: 145 additions & 136 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/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:531](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L531)
8+
Defined in: [packages/db/src/errors.ts:547](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L547)
99

1010
## Extends
1111

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

22-
Defined in: [packages/db/src/errors.ts:532](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L532)
22+
Defined in: [packages/db/src/errors.ts:548](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L548)
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:647](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L647)
8+
Defined in: [packages/db/src/errors.ts:663](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L663)
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:648](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L648)
24+
Defined in: [packages/db/src/errors.ts:664](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L664)
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:610](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L610)
8+
Defined in: [packages/db/src/errors.ts:626](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L626)
99

1010
## Extends
1111

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

22-
Defined in: [packages/db/src/errors.ts:611](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L611)
22+
Defined in: [packages/db/src/errors.ts:627](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L627)
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:391](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L391)
8+
Defined in: [packages/db/src/errors.ts:407](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L407)
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:392](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L392)
28+
Defined in: [packages/db/src/errors.ts:408](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L408)
2929
3030
#### Parameters
3131

‎docs/reference/classes/DeleteKeyNotFoundError.md‎

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

66
# Class: DeleteKeyNotFoundError
77

8-
Defined in: [packages/db/src/errors.ts:204](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L204)
8+
Defined in: [packages/db/src/errors.ts:220](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L220)
99

1010
## Extends
1111

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

22-
Defined in: [packages/db/src/errors.ts:205](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L205)
22+
Defined in: [packages/db/src/errors.ts:221](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L221)
2323

2424
#### Parameters
2525

‎docs/reference/classes/DistinctRequiresSelectError.md‎

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

66
# Class: DistinctRequiresSelectError
77

8-
Defined in: [packages/db/src/errors.ts:367](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L367)
8+
Defined in: [packages/db/src/errors.ts:383](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L383)
99

1010
## Extends
1111

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

22-
Defined in: [packages/db/src/errors.ts:368](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L368)
22+
Defined in: [packages/db/src/errors.ts:384](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L384)
2323

2424
#### Returns
2525

‎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:412](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L412)
8+
Defined in: [packages/db/src/errors.ts:428](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L428)
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:413](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L413)
26+
Defined in: [packages/db/src/errors.ts:429](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L429)
2727

2828
#### Parameters
2929

‎docs/reference/classes/DuplicateKeySyncError.md‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ Defined in: [packages/db/src/errors.ts:162](https://github.com/TanStack/db/blob/
1616
### Constructor
1717

1818
```ts
19-
new DuplicateKeySyncError(key, collectionId): DuplicateKeySyncError;
19+
new DuplicateKeySyncError(
20+
key,
21+
collectionId,
22+
options?): DuplicateKeySyncError;
2023
```
2124
2225
Defined in: [packages/db/src/errors.ts:163](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L163)
@@ -31,6 +34,16 @@ Defined in: [packages/db/src/errors.ts:163](https://github.com/TanStack/db/blob/
3134
3235
`string`
3336
37+
##### options?
38+
39+
###### hasCustomGetKey?
40+
41+
`boolean`
42+
43+
###### hasJoins?
44+
45+
`boolean`
46+
3447
#### Returns
3548
3649
`DuplicateKeySyncError`

‎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:435](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L435)
8+
Defined in: [packages/db/src/errors.ts:451](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L451)
99

1010
## Extends
1111

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

22-
Defined in: [packages/db/src/errors.ts:436](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L436)
22+
Defined in: [packages/db/src/errors.ts:452](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L452)
2323

2424
#### Returns
2525

‎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:510](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L510)
8+
Defined in: [packages/db/src/errors.ts:526](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L526)
99

1010
## Extends
1111

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

29-
Defined in: [packages/db/src/errors.ts:511](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L511)
29+
Defined in: [packages/db/src/errors.ts:527](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L527)
3030

3131
#### Parameters
3232

0 commit comments

Comments
 (0)