fast-ttl-cache 0.0.1 → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 yelin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+
+
+> Written with [StackEdit](https://stackedit.io/).
+
+# fast-ttl-cache
+
+An in-memory cache implemented in Node.js, featuring configurable ttl and a maximum size. It uses a doubly linked list data structure and lazy deletion for expired data, all without relying on any JavaScript timer methods.
+
+## Installation
+
+```shell
+npm install fast-ttl-cache --save
+```
+
+## Usage
+
+```javascript
+import FastTTLCache from 'fast-ttl-cache';
+
+const cache = new FastTTLCache({
+  ttl: 5 * 1000, // ttl in millseconds, get an outdated data will return null and delete it
+  capacity: 1000, // max capacity, When the capacity is exceeded, the least recently updated data will be removed.
+});
+
+cache.put('key1', 'value1');
+cache.put('key2', 'value2');
+cache.get('key2'); // return value2
+
+// wait for 5 seconds
+cache.get('key1'); // return null and key1 will be removed
+cache.size; // return 1, key2 is outdated but is not been removed yet
+
+cache.get('key2'); // return null and key2 will be removed
+cache.size; // return 0
+```
+
+## API
+``` FastTTLCache(options) consturctor```
+options.ttl: number of millseconds, defaults to Infinity
+options.capacity: number of max capacity, defaults to Infinity
+
+```FastTTLCache.prototype.put(key, value)```
+Add or update the value into cache with key and timestamp.
+
+```FastTTLCache.prototype.get(key)```
+Get the value of the key from cache, return null if the key is not exists or has been expired.
+
+``` FastTTLCache.prototype.size```
+return the current size of cache.
+
+## License
+MIT

package/index.mjs

@@ -22,7 +22,7 @@ export default class TTLCache {
    * @param key 缓存键
    * @returns 如果缓存存在且未过期返回值，否则返回null
    */
-  getToken(key) {
+  get(key) {
     const item = this.store.get(key);
     if (!item) return null;
     if (Date.now() - item.time > this.ttl) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fast-ttl-cache",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "ttl cache with capacity support use no timer",
   "type": "module",
   "module": "index.mjs",

package/test.mjs

@@ -23,14 +23,14 @@ c.put('b', 'bbbbbb');
 await sleep(600);
 c.put('d', 'dddd');
 
-console.log('b', c.getToken('b'));
+console.log('b', c.get('b'));
 
 await sleep(600);
 c.put('e', 'eeee');
 
 console.log(c);
 console.log(c.store.keys());
-console.log('b', c.getToken('b'));
-console.log('c', c.getToken('c'));
-console.log('a', c.getToken('a'));
-console.log('e', c.getToken('e'));
+console.log('b', c.get('b'));
+console.log('c', c.get('c'));
+console.log('a', c.get('a'));
+console.log('e', c.get('e'));