flat-cache 6.1.0 → 6.1.2

package/README.md

@@ -1,4 +1,4 @@
-[<img align="center" src="https://cacheable.org/logo.svg" alt="Cacheable" />](https://github.com/jaredwray/cacheable)
+[<img align="center" src="https://cacheable.org/symbol.svg" alt="Cacheable" />](https://github.com/jaredwray/cacheable)
 
 # flat-cache
 > A simple key/value storage using files to persist the data
@@ -7,16 +7,18 @@
 [![tests](https://github.com/jaredwray/cacheable/actions/workflows/tests.yml/badge.svg)](https://github.com/jaredwray/cacheable/actions/workflows/tests.yml)
 [![npm](https://img.shields.io/npm/dm/flat-cache.svg)](https://www.npmjs.com/package/flat-cache)
 [![npm](https://img.shields.io/npm/v/flat-cache)](https://www.npmjs.com/package/flat-cache)
-[![GitHub](https://img.shields.io/github/license/jaredwray/cacheable)](https://github.com/jaredwray/cacheable/blob/main/LICENSE)
+[![license](https://img.shields.io/github/license/jaredwray/cacheable)](https://github.com/jaredwray/cacheable/blob/main/LICENSE)
 
 # Features
 - A simple key/value storage using files to persist the data
 - Uses a in-memory cache (via `CacheableMemory`) as the primary storage and then persists the data to disk
 - Automatically saves the data to disk via `persistInterval` setting. Off By Default
+- Uses `expirationInterval` to check for expired items in the cache. If it is not set it will do a lazy check on `get` or `getKey`
 - Easily Loads the data from disk and into memory with `load` or `loadFile`
 - Uses `ttl` and `lruSize` to manage the cache and persist the data
 - Only saves the data to disk if the data has changed even when using `persistInterval` or calling `save()`
-- Uses `flatted` to parse and stringify the data by default but can be overridden using `parse` and `stringify` in options
+- Uses `flatted` to parse and stringify the data by default but can be overridden using `serialize` and `deserialize` in options
+- ESM and CommonJS support with TypeScript typings and maintained regularly!
 
 # Table of Contents
 - [Installation](#installation)
@@ -117,8 +119,8 @@ In version 6 we attempted to keep as much as the functionality as possible which
 - `persistInterval?` - The interval to save the data to disk. Default is `0` which means no persistence
 - `cacheDir?` - The directory to save the cache files. Default is `./cache`
 - `cacheId?` - The id of the cache. Default is `cache1`
-- `parse?` - The function to parse the data. Default is `flatted.parse`
-- `stringify?` - The function to stringify the data. Default is `flatted.stringify`
+- `serialize?` - The function to parse the data. Default is `flatted.parse`
+- `deserialize?` - The function to stringify the data. Default is `flatted.stringify`
 
 # API
 
@@ -174,8 +176,8 @@ By default `flat-cache` uses `flatted` to parse and stringify the data. This is
 ```javascript
 import { FlatCache } from 'flat-cache';
 const cache = new FlatCache({
-  parse: JSON.parse,
-  stringify: JSON.stringify,
+  deserialize: JSON.parse,
+  serialize: JSON.stringify,
 });
 ```
 

package/dist/index.cjs

@@ -35,7 +35,8 @@ __export(src_exports, {
   clearAll: () => clearAll,
   clearCacheById: () => clearCacheById,
   create: () => create,
-  createFromFile: () => createFromFile
+  createFromFile: () => createFromFile,
+  default: () => FlatCacheDefault
 });
 module.exports = __toCommonJS(src_exports);
 var import_node_path = __toESM(require("path"), 1);
@@ -82,11 +83,11 @@ var FlatCache = class extends import_hookified.Hookified {
       this._persistInterval = options.persistInterval;
       this.startAutoPersist();
     }
-    if (options?.parse) {
-      this._parse = options.parse;
+    if (options?.deserialize) {
+      this._parse = options.deserialize;
     }
-    if (options?.stringify) {
-      this._stringify = options.stringify;
+    if (options?.serialize) {
+      this._stringify = options.serialize;
     }
   }
   /**
@@ -394,6 +395,12 @@ var FlatCache = class extends import_hookified.Hookified {
     }
   }
 };
+var FlatCacheDefault = class {
+  static create = create;
+  static createFromFile = createFromFile;
+  static clearCacheById = clearCacheById;
+  static clearAll = clearAll;
+};
 function create(options) {
   const cache = new FlatCache(options);
   cache.load();

package/dist/index.d.cts

@@ -9,8 +9,8 @@ type FlatCacheOptions = {
     persistInterval?: number;
     cacheDir?: string;
     cacheId?: string;
-    parse?: (data: string) => any;
-    stringify?: (data: any) => string;
+    deserialize?: (data: string) => any;
+    serialize?: (data: any) => string;
 };
 declare enum FlatCacheEvents {
     SAVE = "save",
@@ -212,6 +212,12 @@ declare class FlatCache extends Hookified {
      */
     stopAutoPersist(): void;
 }
+declare class FlatCacheDefault {
+    static create: typeof create;
+    static createFromFile: typeof createFromFile;
+    static clearCacheById: typeof clearCacheById;
+    static clearAll: typeof clearAll;
+}
 /**
  * Load a cache identified by the given Id. If the element does not exists, then initialize an empty
  * cache storage.
@@ -245,4 +251,4 @@ declare function clearCacheById(cacheId: string, cacheDirectory?: string): void;
  */
 declare function clearAll(cacheDirectory?: string): void;
 
-export { FlatCache, FlatCacheEvents, type FlatCacheOptions, clearAll, clearCacheById, create, createFromFile };
+export { FlatCache, FlatCacheEvents, type FlatCacheOptions, clearAll, clearCacheById, create, createFromFile, FlatCacheDefault as default };

package/dist/index.d.ts

@@ -9,8 +9,8 @@ type FlatCacheOptions = {
     persistInterval?: number;
     cacheDir?: string;
     cacheId?: string;
-    parse?: (data: string) => any;
-    stringify?: (data: any) => string;
+    deserialize?: (data: string) => any;
+    serialize?: (data: any) => string;
 };
 declare enum FlatCacheEvents {
     SAVE = "save",
@@ -212,6 +212,12 @@ declare class FlatCache extends Hookified {
      */
     stopAutoPersist(): void;
 }
+declare class FlatCacheDefault {
+    static create: typeof create;
+    static createFromFile: typeof createFromFile;
+    static clearCacheById: typeof clearCacheById;
+    static clearAll: typeof clearAll;
+}
 /**
  * Load a cache identified by the given Id. If the element does not exists, then initialize an empty
  * cache storage.
@@ -245,4 +251,4 @@ declare function clearCacheById(cacheId: string, cacheDirectory?: string): void;
  */
 declare function clearAll(cacheDirectory?: string): void;
 
-export { FlatCache, FlatCacheEvents, type FlatCacheOptions, clearAll, clearCacheById, create, createFromFile };
+export { FlatCache, FlatCacheEvents, type FlatCacheOptions, clearAll, clearCacheById, create, createFromFile, FlatCacheDefault as default };

package/dist/index.js

@@ -43,11 +43,11 @@ var FlatCache = class extends Hookified {
       this._persistInterval = options.persistInterval;
       this.startAutoPersist();
     }
-    if (options?.parse) {
-      this._parse = options.parse;
+    if (options?.deserialize) {
+      this._parse = options.deserialize;
     }
-    if (options?.stringify) {
-      this._stringify = options.stringify;
+    if (options?.serialize) {
+      this._stringify = options.serialize;
     }
   }
   /**
@@ -355,6 +355,12 @@ var FlatCache = class extends Hookified {
     }
   }
 };
+var FlatCacheDefault = class {
+  static create = create;
+  static createFromFile = createFromFile;
+  static clearCacheById = clearCacheById;
+  static clearAll = clearAll;
+};
 function create(options) {
   const cache = new FlatCache(options);
   cache.load();
@@ -378,5 +384,6 @@ export {
   clearAll,
   clearCacheById,
   create,
-  createFromFile
+  createFromFile,
+  FlatCacheDefault as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flat-cache",
-  "version": "6.1.0",
+  "version": "6.1.2",
   "description": "A simple key/value storage using files to persist the data",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -12,33 +12,58 @@
       "import": "./dist/index.js"
     }
   },
-  "repository": "https://github.com/jaredwray/cacheable.git",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jaredwray/cacheable.git",
+    "directory": "packages/flat-cache"
+  },
   "author": "Jared Wray <me@jaredwray.com>",
   "license": "MIT",
   "private": false,
   "keywords": [
     "cache",
     "caching",
-    "node",
-    "nodejs",
     "cacheable",
-    "cacheable-node-cache",
-    "node-cache",
-    "cacheable-node"
+    "flat-cache",
+    "flat",
+    "file",
+    "file-cache",
+    "file-caching",
+    "file-based-cache",
+    "file-persist",
+    "file-persistence",
+    "file-storage",
+    "file-system",
+    "file-management",
+    "filesystem-cache",
+    "disk-cache",
+    "cache-persistence",
+    "cache-persist",
+    "persistent-cache",
+    "persistent-storage",
+    "cache-to-file",
+    "cache-on-disk",
+    "cache-file",
+    "cache-expiration",
+    "cache-lifetime",
+    "data-persistence",
+    "data-storage",
+    "local-storage",
+    "file-system-cache"
   ],
   "devDependencies": {
-    "@types/node": "^22.7.4",
-    "@vitest/coverage-v8": "^2.1.1",
+    "@types/node": "^22.8.1",
+    "@vitest/coverage-v8": "^2.1.3",
     "rimraf": "^6.0.1",
-    "tsup": "^8.3.0",
-    "typescript": "^5.6.2",
-    "vitest": "^2.1.1",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.3",
     "xo": "^0.59.3"
   },
   "dependencies": {
-    "cacheable": "^1.7.1",
+    "cacheable": "^1.8.1",
     "flatted": "^3.3.1",
-    "hookified": "^1.1.0"
+    "hookified": "^1.4.0"
   },
   "files": [
     "dist",