Merge branch 'main' of https://github.com/jaredwray/cacheable

jaredwray · Sep 27, 2024 · c21f6f3 · c21f6f3
2 parents 26225c3 + f124f5e
commit c21f6f3
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/packages/node-cache/README.md b/packages/node-cache/README.md
@@ -79,7 +79,7 @@ When initializing the cache you can pass in the options below:
 
 ```javascript
 export type NodeCacheStoreOptions = {
-	ttl?: number; // The standard ttl as number in seconds for every generated cache element. 0 = unlimited
+	ttl?: number; // The standard ttl as number in milliseconds for every generated cache element. 0 = unlimited
 	primary?: Keyv; // The primary storage adapter
 	secondary?: Keyv; // The secondary storage adapter
 	maxKeys?: number; // Default is 0 (unlimited). If this is set it will throw and error if you try to set more keys than the max.

diff --git a/packages/node-cache/src/store.ts b/packages/node-cache/src/store.ts
@@ -3,7 +3,7 @@ import {Keyv} from 'keyv';
 import {type NodeCacheItem} from 'index.js';
 
 export type NodeCacheStoreOptions = {
-	ttl?: number;
+	ttl?: number; // In milliseconds. This is a breaking change from the original NodeCache.
 	maxKeys?: number;
 	primary?: Keyv;
 	secondary?: Keyv;