Skip to content

docs: regenerate API documentation #1477

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 #1477

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
2 changes: 1 addition & 1 deletion docs/reference/electric-db-collection/functions/isChangeMessage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: isChangeMessage
function isChangeMessage<T>(message): message is ChangeMessage<T>;
```

Defined in: node\_modules/.pnpm/@electric-sql+client@1.5.14/node\_modules/@electric-sql/client/dist/index.d.ts:889
Defined in: node\_modules/.pnpm/@electric-sql+client@1.5.15/node\_modules/@electric-sql/client/dist/index.d.ts:922

Type guard for checking Message is ChangeMessage.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/electric-db-collection/functions/isControlMessage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: isControlMessage
function isControlMessage<T>(message): message is ControlMessage;
```

Defined in: node\_modules/.pnpm/@electric-sql+client@1.5.14/node\_modules/@electric-sql/client/dist/index.d.ts:907
Defined in: node\_modules/.pnpm/@electric-sql+client@1.5.15/node\_modules/@electric-sql/client/dist/index.d.ts:940

Type guard for checking Message is ControlMessage.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/compileQuery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ function compileQuery(
childCorrelationField?): CompilationResult;
```

Defined in: [packages/db/src/query/compiler/index.ts:130](https://github.com/TanStack/db/blob/main/packages/db/src/query/compiler/index.ts#L130)
Defined in: [packages/db/src/query/compiler/index.ts:133](https://github.com/TanStack/db/blob/main/packages/db/src/query/compiler/index.ts#L133)

Compiles a query IR into a D2 pipeline

Expand Down