Skip to content

node.js orms reference #294

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
benitav merged 1 commit into from
Nov 27, 2025
Merged

node.js orms reference #294

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
17 changes: 13 additions & 4 deletions client-sdk-references/node.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import GenerateSchemaAutomatically from '/snippets/generate-schema-automatically.mdx';

<Note>
This page describes the PowerSync _client_ SDK for Node.js.

Check warning on line 14 in client-sdk-references/node.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

client-sdk-references/node.mdx#L14 

Did you really mean '_client_'?
If you're interested in using PowerSync for your Node.js backend, no special package is required.
Instead, follow our guides on [app backend setup](/installation/app-backend-setup).
</Note>
Expand Down Expand Up @@ -198,10 +198,6 @@
Enable verbose output in the developer tools for detailed logs.
</Tip>

## Supported Platforms

See [Supported Platforms -> Node.js SDK](/resources/supported-platforms#node-js-sdk).

## Encryption and custom SQLite drivers

The SDK has an optional dependency on `better-sqlite3` which is used as the default SQLite
Expand Down Expand Up @@ -239,7 +235,7 @@
```

When opening the database, instruct PowerSync to use the custom worker.
Also use the `initializeConnection` option to install an ecryption key:

Check warning on line 238 in client-sdk-references/node.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

client-sdk-references/node.mdx#L238 

Did you really mean 'ecryption'?

```Typescript
const encryptionKey = 'todo: generate encryption key and store it safely';
Expand All @@ -266,9 +262,9 @@
```

<Note>
If you're using a custom compilation toolchain, for instance because you're compiling from TypeScript

Check warning on line 265 in client-sdk-references/node.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

client-sdk-references/node.mdx#L265 

Did you really mean 'toolchain'?
or are applying a bundler to your project, loading workers may require additional configuration on that

Check warning on line 266 in client-sdk-references/node.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

client-sdk-references/node.mdx#L266 

Did you really mean 'bundler'?
toolchain.

Check warning on line 267 in client-sdk-references/node.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

client-sdk-references/node.mdx#L267 

Did you really mean 'toolchain'?
</Note>

### `node:sqlite`
Expand All @@ -293,3 +289,16 @@
There are stability issues when using PowerSync with this API, and it's not recommended outside of
testing purposes at the moment.
</Danger>


## ORM Support

See [JavaScript ORM Support](/client-sdk-references/javascript-web/javascript-orm/overview) for details.

## Troubleshooting

See [Troubleshooting](/resources/troubleshooting) for pointers to debug common issues.

## Supported Platforms

See [Supported Platforms -> Node.js SDK](/resources/supported-platforms#node-js-sdk).