@syncular/dialect-pglite 0.0.1-98 → 0.0.2-126
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# @syncular/dialect-pglite
|
|
2
|
+
|
|
3
|
+
PGlite (WASM Postgres) Kysely dialect for running Postgres locally (in browser or other WASM environments).
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @syncular/dialect-pglite
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
import { createPgliteDbAsync } from '@syncular/dialect-pglite';
|
|
15
|
+
|
|
16
|
+
const db = await createPgliteDbAsync<MyDb>({ dataDir: 'idb://app' });
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Documentation
|
|
20
|
+
|
|
21
|
+
- Dialect selection: https://syncular.dev/docs/introduction/installation#client-database-dialects
|
|
22
|
+
|
|
23
|
+
## Links
|
|
24
|
+
|
|
25
|
+
- GitHub: https://github.com/syncular/syncular
|
|
26
|
+
- Issues: https://github.com/syncular/syncular/issues
|
|
27
|
+
|
|
28
|
+
> Status: Alpha. APIs may change between releases.
|