keyv-dir-store 1.0.0 → 1.0.1

package/README.md

@@ -133,8 +133,8 @@ Creates a new KeyvDirStore instance.
 - `options` (object, optional):
   - `cache` (Map, optional): Custom cache Map to use
   - `filename` (function, optional): Custom filename generator function
-  - `prefix` (string, optional): Path prefix prepended to every key (e.g. `'data/'`)
-  - `suffix` (string, optional): Path suffix appended to every key (default: `.json`)
+  - `prefix` (string, optional): Path prefix prepended to every key (e.g. `'data/'`). Defaults to `''`
+  - `suffix` (string, optional): Path suffix appended to every key (e.g. `'.json'`). Defaults to `''`
 
 #### Example with Custom Options
 

package/dist/index.js

@@ -359,7 +359,7 @@ class KeyvDirStore {
     this.#dir = dir;
     this.#filename = filename ?? this.#defaultFilename;
     this.prefix = prefix ?? "";
-    this.suffix = suffix ?? ".json";
+    this.suffix = suffix ?? "";
   }
   #defaultFilename(key) {
     const readableName = import_sanitize_filename.default(key).slice(0, 16);

package/index.spec.ts

@@ -6,7 +6,7 @@ import { KeyvDirStoreAsJSON } from "./KeyvDirStoreAsJSON";
 it("KeyvDirStore works", async () => {
   // store test
   const kv = new Keyv<number | string | { obj: boolean }>({
-    store: new KeyvDirStore(".cache/test1", { filename: (x) => x }),
+    store: new KeyvDirStore(".cache/test1", { filename: (x) => x, suffix: ".json" }),
     namespace: "",
     deserialize: KeyvDirStore.deserialize,
     serialize: KeyvDirStore.serialize,
@@ -30,7 +30,7 @@ it("KeyvDirStore works", async () => {
 
   // new instance with no cache Obj, to test file cache
   const kv2 = new Keyv<number | string | { obj: boolean }>({
-    store: new KeyvDirStore(".cache/test1", { filename: (x) => x }),
+    store: new KeyvDirStore(".cache/test1", { filename: (x) => x, suffix: ".json" }),
     namespace: "",
     ...KeyvDirStoreAsJSON,
   });

package/index.ts

@@ -45,7 +45,7 @@ export class KeyvDirStore<Value extends string> implements KeyvStoreAdapter {
   namespace?: string;
   /** Path prefix prepended to every key (e.g. 'data/'). Defaults to ''. */
   readonly prefix: string;
-  /** Path suffix appended to every key (e.g. '.json'). Defaults to '.json'. */
+  /** Path suffix appended to every key (e.g. '.json'). Defaults to ''. */
   readonly suffix: string;
   constructor(
     /** dir to cache store
@@ -61,9 +61,9 @@ export class KeyvDirStore<Value extends string> implements KeyvStoreAdapter {
     }: {
       cache?: CacheMap<Value>;
       filename?: (key: string) => string;
-      /** Path prefix prepended to every key (e.g. 'data/'). Use with filename: (k) => k for raw paths. */
+      /** Path prefix prepended to every key (e.g. 'data/'). Defaults to ''. */
       prefix?: string;
-      /** Path suffix appended to every key (e.g. '.json'). Defaults to '.json'. Use with filename: (k) => k for raw paths. */
+      /** Path suffix appended to every key (e.g. '.json'). Defaults to ''. */
       suffix?: string;
     } = {},
   ) {
@@ -72,7 +72,7 @@ export class KeyvDirStore<Value extends string> implements KeyvStoreAdapter {
     this.#dir = dir;
     this.#filename = filename ?? this.#defaultFilename;
     this.prefix = prefix ?? "";
-    this.suffix = suffix ?? ".json";
+    this.suffix = suffix ?? "";
   }
   #defaultFilename(key: string) {
     // use dir as hash salt to avoid collisions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keyv-dir-store",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "High performance Filesystem Keyv Store, caches each key-value pair into a $key.json. and more! *.JSON, *.YAML, *.CSV is also avaliable.",
   "keywords": [
     "keyv",