extra-disk-store 0.1.1 → 0.1.3

package/README.md

@@ -12,7 +12,7 @@ yarn add extra-disk-store
 ```ts
 import { DiskStore } from 'extra-disk-store'
 
-const store = new DiskStore('/tmp/store')
+const store = await DiskStore.create('/tmp/store')
 store.set('key', Buffer.from('value'))
 const value = store.get('key')
 ```
@@ -34,7 +34,7 @@ class DiskStore {
   set(key: string, value: Buffer): void
   delete(key: string): void
   clear(): void
-  keys(): Iterable<string>
+  keys(): IterableIterator<string>
 }
 ```
 
@@ -90,7 +90,7 @@ class DiskStoreAsyncView<K, V> {
   set(key: K, value: V): Promise<void>
   delete(key: K): Promise<void>
   clear(): void
-  keys(): AsyncIterable<K>
+  keys(): AsyncIterableIterator<K>
 }
 ```
 
@@ -139,3 +139,30 @@ class ZstandardValueConverter<T> implements IValueConverter<T>, IValueAsyncConve
   , level: number
   ): Promise<ZstandardValueConverter<T>>
 }
+```
+
+#### PrefixKeyConverter
+```ts
+class PrefixKeyConverter<T> implements IKeyConverter<T>, IKeyAsyncConverter<T> {
+  constructor(
+    keyConverter: IKeyConverter<T>
+  , prefix: string
+  )
+
+  toString(value: T): string
+  fromString(value: string): T
+}
+```
+
+#### PrefixKeyAsyncConverter
+```ts
+class PrefixKeyAsyncConverter<T> implements IKeyAsyncConverter<T> {
+  constructor(
+    keyConverter: IKeyConverter<T> | IKeyAsyncConverter<T>
+  , prefix: string
+  )
+
+  toString(value: T): Promise<string>
+  fromString(value: string): Promise<T>
+}
+```

package/lib/converters/index.d.ts

@@ -3,5 +3,6 @@ export * from './json-value-converter';
 export * from './passthrough-key-converter';
 export * from './passthrough-value-converter';
 export * from './index-key-converter';
+export * from './prefix-key-converter';
 export * from './lz4-value-converter';
 export * from './zstandard-value-converter';

package/lib/converters/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./json-value-converter"), exports);
 __exportStar(require("./passthrough-key-converter"), exports);
 __exportStar(require("./passthrough-value-converter"), exports);
 __exportStar(require("./index-key-converter"), exports);
+__exportStar(require("./prefix-key-converter"), exports);
 __exportStar(require("./lz4-value-converter"), exports);
 __exportStar(require("./zstandard-value-converter"), exports);
 //# sourceMappingURL=index.js.map

package/lib/converters/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/converters/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAoC;AACpC,yDAAsC;AAEtC,8DAA2C;AAC3C,gEAA6C;AAE7C,wDAAqC;AAErC,wDAAqC;AACrC,8DAA2C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/converters/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAoC;AACpC,yDAAsC;AAEtC,8DAA2C;AAC3C,gEAA6C;AAE7C,wDAAqC;AACrC,yDAAsC;AAEtC,wDAAqC;AACrC,8DAA2C"}

package/lib/converters/prefix-key-converter.d.ts

@@ -0,0 +1,15 @@
+import { IKeyConverter, IKeyAsyncConverter } from "../types";
+export declare class PrefixKeyConverter<T> implements IKeyConverter<T>, IKeyAsyncConverter<T> {
+    private keyConverter;
+    private prefix;
+    constructor(keyConverter: IKeyConverter<T>, prefix: string);
+    toString(value: T): string;
+    fromString(value: string): T;
+}
+export declare class PrefixKeyAsyncConverter<T> implements IKeyAsyncConverter<T> {
+    private keyConverter;
+    private prefix;
+    constructor(keyConverter: IKeyConverter<T> | IKeyAsyncConverter<T>, prefix: string);
+    toString(value: T): Promise<string>;
+    fromString(value: string): Promise<T>;
+}

package/lib/converters/prefix-key-converter.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrefixKeyAsyncConverter = exports.PrefixKeyConverter = void 0;
+const prelude_1 = require("@blackglory/prelude");
+class PrefixKeyConverter {
+    constructor(keyConverter, prefix) {
+        this.keyConverter = keyConverter;
+        this.prefix = prefix;
+    }
+    toString(value) {
+        const key = this.keyConverter.toString(value);
+        return this.prefix + key;
+    }
+    fromString(value) {
+        (0, prelude_1.assert)(value.startsWith(this.prefix), 'The key does not start with prefix');
+        const key = this.keyConverter.fromString(value.slice(this.prefix.length));
+        return key;
+    }
+}
+exports.PrefixKeyConverter = PrefixKeyConverter;
+class PrefixKeyAsyncConverter {
+    constructor(keyConverter, prefix) {
+        this.keyConverter = keyConverter;
+        this.prefix = prefix;
+    }
+    async toString(value) {
+        const key = await this.keyConverter.toString(value);
+        return this.prefix + key;
+    }
+    async fromString(value) {
+        (0, prelude_1.assert)(value.startsWith(this.prefix), 'The key does not start with prefix');
+        const key = await this.keyConverter.fromString(value.slice(this.prefix.length));
+        return key;
+    }
+}
+exports.PrefixKeyAsyncConverter = PrefixKeyAsyncConverter;
+//# sourceMappingURL=prefix-key-converter.js.map

package/lib/converters/prefix-key-converter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefix-key-converter.js","sourceRoot":"","sources":["../../src/converters/prefix-key-converter.ts"],"names":[],"mappings":";;;AACA,iDAA4C;AAE5C,MAAa,kBAAkB;IAC7B,YACU,YAA8B,EAC9B,MAAc;QADd,iBAAY,GAAZ,YAAY,CAAkB;QAC9B,WAAM,GAAN,MAAM,CAAQ;IACrB,CAAC;IAEJ,QAAQ,CAAC,KAAQ;QACf,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QAC7C,OAAO,IAAI,CAAC,MAAM,GAAG,GAAG,CAAA;IAC1B,CAAC;IAED,UAAU,CAAC,KAAa;QACtB,IAAA,gBAAM,EAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,oCAAoC,CAAC,CAAA;QAE3E,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;QACzE,OAAO,GAAG,CAAA;IACZ,CAAC;CACF;AAjBD,gDAiBC;AAED,MAAa,uBAAuB;IAClC,YACU,YAAsD,EACtD,MAAc;QADd,iBAAY,GAAZ,YAAY,CAA0C;QACtD,WAAM,GAAN,MAAM,CAAQ;IACrB,CAAC;IAEJ,KAAK,CAAC,QAAQ,CAAC,KAAQ;QACrB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QACnD,OAAO,IAAI,CAAC,MAAM,GAAG,GAAG,CAAA;IAC1B,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAa;QAC5B,IAAA,gBAAM,EAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,oCAAoC,CAAC,CAAA;QAE3E,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;QAC/E,OAAO,GAAG,CAAA;IACZ,CAAC;CACF;AAjBD,0DAiBC"}

package/lib/disk-store-async-view.d.ts

@@ -10,5 +10,5 @@ export declare class DiskStoreAsyncView<K, V> {
     set(key: K, value: V): Promise<void>;
     delete(key: K): Promise<void>;
     clear(): void;
-    keys(): AsyncIterable<K>;
+    keys(): AsyncIterableIterator<K>;
 }

package/lib/disk-store-view.d.ts

@@ -10,5 +10,5 @@ export declare class DiskStoreView<K, V> {
     set(key: K, value: V): void;
     delete(key: K): void;
     clear(): void;
-    keys(): Iterable<K>;
+    keys(): IterableIterator<K>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extra-disk-store",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "",
   "keywords": [],
   "files": [
@@ -43,7 +43,7 @@
     "@types/node": "14",
     "@typescript-eslint/eslint-plugin": "^5.45.0",
     "@typescript-eslint/parser": "^5.45.0",
-    "eslint": "^8.28.0",
+    "eslint": "^8.29.0",
     "husky": "^4.3.0",
     "jest": "^29.3.1",
     "npm-run-all": "^4.1.5",
@@ -59,7 +59,7 @@
     "@blackglory/prelude": "^0.1.8",
     "@blackglory/types": "^1.4.0",
     "@bokuweb/zstd-wasm": "^0.0.17",
-    "better-sqlite3": "^8.0.0",
+    "better-sqlite3": "^8.0.1",
     "extra-filesystem": "^0.4.8",
     "extra-lazy": "^1.3.1",
     "extra-promise": "^4.4.0",