Skip to content

docs: regenerate API documentation #1160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: regenerate API documentation #1160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/reference/classes/AggregateFunctionNotInSelectError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: AggregateFunctionNotInSelectError

# Class: AggregateFunctionNotInSelectError

Defined in: [packages/db/src/errors.ts:578](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L578)
Defined in: [packages/db/src/errors.ts:594](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L594)

## Extends

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

Defined in: [packages/db/src/errors.ts:579](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L579)
Defined in: [packages/db/src/errors.ts:595](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L595)

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/AggregateNotSupportedError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: AggregateNotSupportedError

# Class: AggregateNotSupportedError

Defined in: [packages/db/src/errors.ts:694](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L694)
Defined in: [packages/db/src/errors.ts:710](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L710)

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

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

Defined in: [packages/db/src/errors.ts:695](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L695)
Defined in: [packages/db/src/errors.ts:711](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L711)

#### Returns

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/CannotCombineEmptyExpressionListError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: CannotCombineEmptyExpressionListError

# Class: CannotCombineEmptyExpressionListError

Defined in: [packages/db/src/errors.ts:657](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L657)
Defined in: [packages/db/src/errors.ts:673](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L673)

## Extends

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

Defined in: [packages/db/src/errors.ts:658](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L658)
Defined in: [packages/db/src/errors.ts:674](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L674)

#### Returns

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/CollectionInputNotFoundError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: CollectionInputNotFoundError

# Class: CollectionInputNotFoundError

Defined in: [packages/db/src/errors.ts:438](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L438)
Defined in: [packages/db/src/errors.ts:454](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L454)

Error thrown when a collection input stream is not found during query compilation.
In self-joins, each alias (e.g., 'employee', 'manager') requires its own input stream.
Expand All @@ -25,7 +25,7 @@ new CollectionInputNotFoundError(
availableKeys?): CollectionInputNotFoundError;
```

Defined in: [packages/db/src/errors.ts:439](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L439)
Defined in: [packages/db/src/errors.ts:455](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L455)

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/DeleteKeyNotFoundError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: DeleteKeyNotFoundError

# Class: DeleteKeyNotFoundError

Defined in: [packages/db/src/errors.ts:229](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L229)
Defined in: [packages/db/src/errors.ts:245](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L245)

## Extends

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

Defined in: [packages/db/src/errors.ts:230](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L230)
Defined in: [packages/db/src/errors.ts:246](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L246)

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/DistinctRequiresSelectError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: DistinctRequiresSelectError

# Class: DistinctRequiresSelectError

Defined in: [packages/db/src/errors.ts:414](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L414)
Defined in: [packages/db/src/errors.ts:430](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L430)

## Extends

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

Defined in: [packages/db/src/errors.ts:415](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L415)
Defined in: [packages/db/src/errors.ts:431](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L431)

#### Returns

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/DuplicateAliasInSubqueryError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: DuplicateAliasInSubqueryError

# Class: DuplicateAliasInSubqueryError

Defined in: [packages/db/src/errors.ts:459](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L459)
Defined in: [packages/db/src/errors.ts:475](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L475)

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

Defined in: [packages/db/src/errors.ts:460](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L460)
Defined in: [packages/db/src/errors.ts:476](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L476)

#### Parameters

Expand Down
4 changes: 4 additions & 0 deletions docs/reference/classes/DuplicateKeySyncError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ Defined in: [packages/db/src/errors.ts:172](https://github.com/TanStack/db/blob/

`boolean`

###### hasDistinct?

`boolean`

###### hasJoins?

`boolean`
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/EmptyReferencePathError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: EmptyReferencePathError

# Class: EmptyReferencePathError

Defined in: [packages/db/src/errors.ts:482](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L482)
Defined in: [packages/db/src/errors.ts:498](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L498)

## Extends

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

Defined in: [packages/db/src/errors.ts:483](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L483)
Defined in: [packages/db/src/errors.ts:499](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L499)

#### Returns

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/GroupByError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: GroupByError

# Class: GroupByError

Defined in: [packages/db/src/errors.ts:557](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L557)
Defined in: [packages/db/src/errors.ts:573](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L573)

## Extends

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

Defined in: [packages/db/src/errors.ts:558](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L558)
Defined in: [packages/db/src/errors.ts:574](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L574)

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/HavingRequiresGroupByError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: HavingRequiresGroupByError

# Class: HavingRequiresGroupByError

Defined in: [packages/db/src/errors.ts:420](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L420)
Defined in: [packages/db/src/errors.ts:436](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L436)

## Extends

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

Defined in: [packages/db/src/errors.ts:421](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L421)
Defined in: [packages/db/src/errors.ts:437](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L437)

#### Returns

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/InvalidJoinCondition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: InvalidJoinCondition

# Class: InvalidJoinCondition

Defined in: [packages/db/src/errors.ts:544](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L544)
Defined in: [packages/db/src/errors.ts:560](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L560)

## Extends

Expand All @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:544](https://github.com/TanStack/db/blob/
new InvalidJoinCondition(): InvalidJoinCondition;
```

Defined in: [packages/db/src/errors.ts:545](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L545)
Defined in: [packages/db/src/errors.ts:561](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L561)

#### Returns

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/InvalidJoinConditionLeftSourceError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: InvalidJoinConditionLeftSourceError

# Class: InvalidJoinConditionLeftSourceError

Defined in: [packages/db/src/errors.ts:528](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L528)
Defined in: [packages/db/src/errors.ts:544](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L544)

## Extends

Expand All @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:528](https://github.com/TanStack/db/blob/
new InvalidJoinConditionLeftSourceError(sourceAlias): InvalidJoinConditionLeftSourceError;
```

Defined in: [packages/db/src/errors.ts:529](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L529)
Defined in: [packages/db/src/errors.ts:545](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L545)

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/InvalidJoinConditionRightSourceError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: InvalidJoinConditionRightSourceError

# Class: InvalidJoinConditionRightSourceError

Defined in: [packages/db/src/errors.ts:536](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L536)
Defined in: [packages/db/src/errors.ts:552](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L552)

## Extends

Expand All @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:536](https://github.com/TanStack/db/blob/
new InvalidJoinConditionRightSourceError(sourceAlias): InvalidJoinConditionRightSourceError;
```

Defined in: [packages/db/src/errors.ts:537](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L537)
Defined in: [packages/db/src/errors.ts:553](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L553)

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/InvalidJoinConditionSameSourceError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: InvalidJoinConditionSameSourceError

# Class: InvalidJoinConditionSameSourceError

Defined in: [packages/db/src/errors.ts:514](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L514)
Defined in: [packages/db/src/errors.ts:530](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L530)

## Extends

Expand All @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:514](https://github.com/TanStack/db/blob/
new InvalidJoinConditionSameSourceError(sourceAlias): InvalidJoinConditionSameSourceError;
```

Defined in: [packages/db/src/errors.ts:515](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L515)
Defined in: [packages/db/src/errors.ts:531](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L531)

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/InvalidJoinConditionSourceMismatchError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: InvalidJoinConditionSourceMismatchError

# Class: InvalidJoinConditionSourceMismatchError

Defined in: [packages/db/src/errors.ts:522](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L522)
Defined in: [packages/db/src/errors.ts:538](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L538)

## Extends

Expand All @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:522](https://github.com/TanStack/db/blob/
new InvalidJoinConditionSourceMismatchError(): InvalidJoinConditionSourceMismatchError;
```

Defined in: [packages/db/src/errors.ts:523](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L523)
Defined in: [packages/db/src/errors.ts:539](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L539)

#### Returns

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/InvalidSourceError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: InvalidSourceError

# Class: InvalidSourceError

Defined in: [packages/db/src/errors.ts:364](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L364)
Defined in: [packages/db/src/errors.ts:380](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L380)

## Extends

Expand All @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:364](https://github.com/TanStack/db/blob/
new InvalidSourceError(alias): InvalidSourceError;
```

Defined in: [packages/db/src/errors.ts:365](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L365)
Defined in: [packages/db/src/errors.ts:381](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L381)

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/InvalidSourceTypeError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: InvalidSourceTypeError

# Class: InvalidSourceTypeError

Defined in: [packages/db/src/errors.ts:372](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L372)
Defined in: [packages/db/src/errors.ts:388](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L388)

## Extends

Expand All @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:372](https://github.com/TanStack/db/blob/
new InvalidSourceTypeError(context, type): InvalidSourceTypeError;
```

Defined in: [packages/db/src/errors.ts:373](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L373)
Defined in: [packages/db/src/errors.ts:389](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L389)

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/InvalidStorageDataFormatError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: InvalidStorageDataFormatError

# Class: InvalidStorageDataFormatError

Defined in: [packages/db/src/errors.ts:622](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L622)
Defined in: [packages/db/src/errors.ts:638](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L638)

## Extends

Expand All @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:622](https://github.com/TanStack/db/blob/
new InvalidStorageDataFormatError(storageKey, key): InvalidStorageDataFormatError;
```

Defined in: [packages/db/src/errors.ts:623](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L623)
Defined in: [packages/db/src/errors.ts:639](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L639)

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/InvalidStorageObjectFormatError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: InvalidStorageObjectFormatError

# Class: InvalidStorageObjectFormatError

Defined in: [packages/db/src/errors.ts:630](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L630)
Defined in: [packages/db/src/errors.ts:646](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L646)

## Extends

Expand All @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:630](https://github.com/TanStack/db/blob/
new InvalidStorageObjectFormatError(storageKey): InvalidStorageObjectFormatError;
```

Defined in: [packages/db/src/errors.ts:631](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L631)
Defined in: [packages/db/src/errors.ts:647](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L647)

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/InvalidWhereExpressionError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: InvalidWhereExpressionError

# Class: InvalidWhereExpressionError

Defined in: [packages/db/src/errors.ts:393](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L393)
Defined in: [packages/db/src/errors.ts:409](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L409)

## Extends

Expand All @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:393](https://github.com/TanStack/db/blob/
new InvalidWhereExpressionError(valueType): InvalidWhereExpressionError;
```

Defined in: [packages/db/src/errors.ts:394](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L394)
Defined in: [packages/db/src/errors.ts:410](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L410)

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/classes/JoinCollectionNotFoundError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: JoinCollectionNotFoundError

# Class: JoinCollectionNotFoundError

Defined in: [packages/db/src/errors.ts:494](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L494)
Defined in: [packages/db/src/errors.ts:510](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L510)

## Extends

Expand All @@ -19,7 +19,7 @@ Defined in: [packages/db/src/errors.ts:494](https://github.com/TanStack/db/blob/
new JoinCollectionNotFoundError(collectionId): JoinCollectionNotFoundError;
```

Defined in: [packages/db/src/errors.ts:495](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L495)
Defined in: [packages/db/src/errors.ts:511](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L511)

#### Parameters

Expand Down
Loading