bun-sqlite-key-value - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

package.json

 {
   "name": "bun-sqlite-key-value",
   "description": "A key-value store with SQLite that uses bun:sqlite and v8 as a fast Json replacement.",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "author": "Gerold Penz<[e-mail]>",
@@ -6,0 +6,0 @@ "module": "src/index.ts",

README.md

 # Bun SQLite Key Value
-A key-value store with SQLite that uses bun:sqlite and v8 as a fast Json replacement.
+A key-value store with SQLite that uses bun:sqlite and v8 as a fast JSON replacement.
 
@@ -17,3 +17,4 @@ The ideas for the implementation come from
 
-Using this cache is dead simple: simply create a new BunSQLiteCache instance and you're set
+Using this key value store is dead simple:
+simply create a new BunSQLiteKeyValue instance and you're set
 
@@ -31,1 +32,28 @@ ```typescript
 
+## Documentation
+
+
+### Open Database
+
+`const store = new BunSQLiteKeyValue([filename], [options])`
+
+- `filename`
+The full path of the SQLite database to open.
+Pass an empty string (`""`) or `":memory:"` or undefined for an in-memory database.
+
+- `options`
+Defaults to `{readwrite: true, create: true}`.
+If a number, then it's treated as `SQLITE_OPEN_*` constant flags.
+
+
+#### Example
+
+```typescript
+import { BunSQLiteKeyValue } from "bun-sqlite-key-value";
+import {join} from "path"
+
+const store = new BunSQLiteKeyValue();
+```
+
+
+

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17172

increased by15.09%

Number of package files

11

increased by10%

Lines of code

354

increased by13.46%

Number of lines in readme file

58

increased by93.33%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes