Skip to content

docs: regenerate API documentation #1182

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

Merged
KyleAMathews merged 1 commit into from
Jan 27, 2026
Merged

docs: regenerate API documentation #1182

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/electric-db-collection/functions/electricCollectionOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: electricCollectionOptions
function electricCollectionOptions<T>(config): Omit<CollectionConfig<InferSchemaOutput<T>, string | number, T, UtilsRecord>, "utils"> & object;
```

Defined in: [packages/electric-db-collection/src/electric.ts:511](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L511)
Defined in: [packages/electric-db-collection/src/electric.ts:510](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L510)

Creates Electric collection options for use with a standard Collection

Expand Down Expand Up @@ -43,7 +43,7 @@ Collection options with utilities
function electricCollectionOptions<T>(config): Omit<CollectionConfig<T, string | number, never, UtilsRecord>, "utils"> & object;
```

Defined in: [packages/electric-db-collection/src/electric.ts:522](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L522)
Defined in: [packages/electric-db-collection/src/electric.ts:521](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L521)

Creates Electric collection options for use with a standard Collection

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/electric-db-collection/interfaces/ElectricCollectionUtils.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: ElectricCollectionUtils

# Interface: ElectricCollectionUtils\<T\>

Defined in: [packages/electric-db-collection/src/electric.ts:493](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L493)
Defined in: [packages/electric-db-collection/src/electric.ts:492](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L492)

Electric collection utilities type

Expand Down Expand Up @@ -33,7 +33,7 @@ Electric collection utilities type
awaitMatch: AwaitMatchFn<T>;
```

Defined in: [packages/electric-db-collection/src/electric.ts:497](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L497)
Defined in: [packages/electric-db-collection/src/electric.ts:496](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L496)

***

Expand All @@ -43,4 +43,4 @@ Defined in: [packages/electric-db-collection/src/electric.ts:497](https://github
awaitTxId: AwaitTxIdFn;
```

Defined in: [packages/electric-db-collection/src/electric.ts:496](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L496)
Defined in: [packages/electric-db-collection/src/electric.ts:495](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L495)
2 changes: 1 addition & 1 deletion docs/reference/electric-db-collection/type-aliases/AwaitTxIdFn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: AwaitTxIdFn
type AwaitTxIdFn = (txId, timeout?) => Promise<boolean>;
```

Defined in: [packages/electric-db-collection/src/electric.ts:480](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L480)
Defined in: [packages/electric-db-collection/src/electric.ts:479](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L479)

Type for the awaitTxId utility function

Expand Down