Skip to content

Fix some small things in the docs #1386

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
fulopkovacs wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix some small things in the docs #1386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0819fd9
docs: update code block language to typescript
fulopkovacs Mar 19, 2026
2c509a1
docs: correct TanStack Starter to Start
fulopkovacs Mar 19, 2026
91a697a
docs: fix the default timeout of `awaitTxId` (it's 5s instead of 30s)
fulopkovacs Mar 19, 2026
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
6 changes: 3 additions & 3 deletions docs/collections/electric-collection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,9 @@ async function generateTxId(tx) {
Electric is typically deployed behind a proxy server that handles shape configuration, authentication and authorization. This provides better security and allows you to control what data users can access without exposing Electric to the client.


Here is an example proxy implementation using TanStack Starter:
Here is an example proxy implementation using TanStack Start:

```js
```typescript
import { createServerFileRoute } from "@tanstack/react-start/server"
import { ELECTRIC_PROTOCOL_QUERY_PARAMS } from "@electric-sql/client"

Expand Down Expand Up @@ -311,7 +311,7 @@ Manually wait for a specific transaction ID to be synchronized:
// Wait for specific txid
await todosCollection.utils.awaitTxId(12345)

// With custom timeout (default is 30 seconds)
// With custom timeout (default is 5 seconds)
await todosCollection.utils.awaitTxId(12345, 10000)
```

Expand Down
2 changes: 1 addition & 1 deletion packages/db/skills/db-core/collection-setup/references/electric-adapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ onInsert: async ({ transaction }) => {

## Utility Methods (`collection.utils`)

- `awaitTxId(txid, timeout?)` -- wait for txid in Electric stream; default timeout 30s
- `awaitTxId(txid, timeout?)` -- wait for txid in Electric stream; default timeout 5s
- `awaitMatch(matchFn, timeout?)` -- wait for message matching predicate; default timeout 3000ms

### Helper Exports
Expand Down
Loading