polystore 0.15.0 → 0.15.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polystore",
-  "version": "0.15.0",
+  "version": "0.15.1",
   "description": "A small compatibility layer for many popular KV stores like localStorage, Redis, FileSystem, etc.",
   "homepage": "https://polystore.dev/",
   "repository": "https://github.com/franciscop/polystore.git",

package/readme.md

@@ -700,7 +700,7 @@ await fsp.writeFile(file, serialValue);
 
 ### Folder
 
-Treat a single folder in your filesystem as the source for the KV store, with each key being within a file:
+Treat a single folder in your filesystem as the store, where each key is a file:
 
 ```js
 import kv from "polystore";
@@ -708,6 +708,7 @@ import kv from "polystore";
 const store = kv(new URL("file:///Users/me/project/data/"));
 
 await store.set("key1", "Hello world", { expires: "1h" });
+// Writes "./data/key1.json"
 console.log(await store.get("key1"));
 // "Hello world"
 ```
@@ -717,12 +718,14 @@ console.log(await store.get("key1"));
 You can also create multiple stores:
 
 ```js
-// Paths need to be absolute, but you can use process.cwd() to make
-// it relative to the current process:
+// Paths need to be absolute, but you can use `process.cwd()` to make
+// it relative to the current process, or `import.meta.dirname`:
 const store1 = kv(new URL(`file://${process.cwd()}/cache/`));
 const store2 = kv(new URL(`file://${import.meta.dirname}/data/`));
 ```
 
+The folder is created if it doesn't exist. When a key is deleted, the corresponding file is also deleted. The data is serialized as JSON, with a meta wrapper to store the expiration date.
+
 <details>
   <summary>Why use polystore with a folder?</summary>
   <p>These benefits are for wrapping a folder with polystore:</p>

package/src/clients/file.js

@@ -29,7 +29,8 @@ export default class File {
       // We want to make sure the file already exists, so attempt to
       // create the folders and the file (but not OVERWRITE it, that's why the x flag)
       // It fails if it already exists, hence the catch case
-      await fsp.mkdir(path.dirname(this.file), { recursive: true });
+      const folder = path.dirname(this.file);
+      await fsp.mkdir(folder, { recursive: true }).catch(() => {});
       await fsp.writeFile(this.file, "{}", { flag: "wx" }).catch((err) => {
         if (err.code !== "EEXIST") throw err;
       });

package/src/clients/folder.js

@@ -32,7 +32,7 @@ export default class Folder {
 
       // Make sure the folder already exists, so attempt to create it
       // It fails if it already exists, hence the catch case
-      await fsp.mkdir(this.folder, { recursive: true }).catch((err) => {});
+      await fsp.mkdir(this.folder, { recursive: true }).catch(() => {});
       return fsp;
     })();
   }