@fedify/sqlite 1.8.1-pr.318.1252 → 1.8.1-pr.318.1253

package/README.md

@@ -1,11 +1,21 @@
 @fedify/sqlite: SQLite drivers for Fedify
-==============
+=========================================
 
-This package provides a SQLite-based key–value store implementation.
+[![JSR][JSR badge]][JSR]
+[![npm][npm badge]][npm]
+
+This package provides a SQLite-based [`KvStore`] implementation for [Fedify].
+
+[JSR]: https://jsr.io/@fedify/sqlite
+[JSR badge]: https://jsr.io/badges/@fedify/sqlite
+[npm]: https://www.npmjs.com/package/@fedify/sqlite
+[npm badge]: https://img.shields.io/npm/v/@fedify/sqlite?logo=npm
+[Fedify]: https://fedify.dev/
+[`KvStore`]: https://jsr.io/@fedify/fedify/doc/federation/~/KvStore
 
 ## Usage
 
-### Node.js
+### Deno
 
 ```typescript
 import { DatabaseSync } from 'node:sqlite';
@@ -15,24 +25,22 @@ const db = new DatabaseSync('./data.db');
 const store = new SqliteKvStore(db);
 ```
 
-### Bun
+### Node.js
 
 ```typescript
-import { Database } from 'bun:sqlite';
+import { DatabaseSync } from 'node:sqlite';
 import { SqliteKvStore } from '@fedify/sqlite';
 
-const db = new Database('./data.db');
+const db = new DatabaseSync('./data.db');
 const store = new SqliteKvStore(db);
 ```
 
-### Deno
-
-For Deno, you can directly import from `@fedify/sqlite` when using the import map in `deno.json`:
+### Bun
 
 ```typescript
-import { DB } from 'https://deno.land/x/sqlite@v3.7.0/mod.ts';
+import { Database } from 'bun:sqlite';
 import { SqliteKvStore } from '@fedify/sqlite';
 
-const db = new DB('./data.db');
+const db = new Database('./data.db');
 const store = new SqliteKvStore(db);
 ```

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/sqlite",
-  "version": "1.8.1-pr.318.1252+da9acceb",
+  "version": "1.8.1-pr.318.1253+df65498e",
   "license": "MIT",
   "exports": {
     ".": "./mod.ts",

package/dist/kv.d.ts

@@ -40,6 +40,11 @@ declare class SqliteKvStore implements KvStore {
   #private;
   readonly db: PlatformDatabase;
   readonly options: SqliteKvStoreOptions;
+  /**
+   * Creates a new SQLite key–value store.
+   * @param db The SQLite database to use. Supports `node:sqlite` and `bun:sqlite`.
+   * @param options The options for the key–value store.
+   */
   constructor(db: PlatformDatabase, options?: SqliteKvStoreOptions);
   /**
    * {@inheritDoc KvStore.get}

package/dist/kv.js

@@ -34,6 +34,11 @@ var SqliteKvStore = class SqliteKvStore {
 	#db;
 	#tableName;
 	#initialized;
+	/**
+	* Creates a new SQLite key–value store.
+	* @param db The SQLite database to use. Supports `node:sqlite` and `bun:sqlite`.
+	* @param options The options for the key–value store.
+	*/
 	constructor(db, options = {}) {
 		this.db = db;
 		this.options = options;

package/kv.ts

@@ -49,6 +49,11 @@ export class SqliteKvStore implements KvStore {
   readonly #tableName: string;
   #initialized: boolean;
 
+  /**
+   * Creates a new SQLite key–value store.
+   * @param db The SQLite database to use. Supports `node:sqlite` and `bun:sqlite`.
+   * @param options The options for the key–value store.
+   */
   constructor(
     readonly db: PlatformDatabase,
     readonly options: SqliteKvStoreOptions = {},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/sqlite",
-  "version": "1.8.1-pr.318.1252+da9acceb",
+  "version": "1.8.1-pr.318.1253+df65498e",
   "description": "SQLite drivers for Fedify",
   "keywords": [
     "fedify",
@@ -51,7 +51,7 @@
     "es-toolkit": "^1.31.0"
   },
   "peerDependencies": {
-    "@fedify/fedify": "1.8.1-pr.318.1252+da9acceb"
+    "@fedify/fedify": "1.8.1-pr.318.1253+df65498e"
   },
   "devDependencies": {
     "@js-temporal/polyfill": "^0.5.1",