@syncular/dialect-electron-sqlite 0.0.1 → 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 +31 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# @syncular/dialect-electron-sqlite
|
|
2
|
+
|
|
3
|
+
Electron IPC SQLite Kysely dialect for renderer processes.
|
|
4
|
+
|
|
5
|
+
This dialect lets renderer code use a normal Kysely API while executing SQL in the Electron main process through a preload bridge.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @syncular/dialect-electron-sqlite
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { createElectronSqliteDbFromWindow } from '@syncular/dialect-electron-sqlite';
|
|
17
|
+
|
|
18
|
+
// Uses window.electronAPI.sqlite by default (bridgeKey: "sqlite")
|
|
19
|
+
const db = createElectronSqliteDbFromWindow<MyDb>();
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Documentation
|
|
23
|
+
|
|
24
|
+
- Dialect selection: https://syncular.dev/docs/introduction/installation#client-database-dialects
|
|
25
|
+
|
|
26
|
+
## Links
|
|
27
|
+
|
|
28
|
+
- GitHub: https://github.com/syncular/syncular
|
|
29
|
+
- Issues: https://github.com/syncular/syncular/issues
|
|
30
|
+
|
|
31
|
+
> Status: Alpha. APIs may change between releases.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@syncular/dialect-electron-sqlite",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2-126",
|
|
4
4
|
"description": "Electron IPC SQLite dialect for the Syncular client",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Benjamin Kniffler",
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"release": "bunx syncular-publish"
|
|
44
44
|
},
|
|
45
45
|
"dependencies": {
|
|
46
|
-
"@syncular/core": "0.0.
|
|
46
|
+
"@syncular/core": "0.0.2-126"
|
|
47
47
|
},
|
|
48
48
|
"peerDependencies": {
|
|
49
49
|
"kysely": "^0.28.0"
|