mini-cache-ttl

Installation

To install the mini-cache-ttl package, use the following command:

npm install mini-cache-ttl

Usage

You can use the mini-cache-ttl package in the following ways:

1. Global Store:

import cache from 'mini-cache-ttl';

cache.set('key', 'value', 60); // Set a value with a TTL of 60 seconds
const value = cache.get('key'); // Get the value

2. Custom Stores:

import { createStore } from 'mini-cache-ttl';

const store = createStore();
store.set('key', 'value', 60);
const value = store.get('key');

3. Express Session Store:

import { expressSessionStore } from 'mini-cache-ttl';

const MiniCacheSessionStore = await expressSessionStore();
// Use MiniCacheSessionStore as the session store in your Express app

API

The mini-cache-ttl package provides the following API:

• cache.get(key): Retrieve the value for the given key.
• cache.set(key, value, ttlSec): Set a value for the given key with an optional Time-To-Live (TTL) in seconds.
• cache.update(key, value, ttlSec): Update the value and/or TTL for the given key.
• cache.rename(oldKey, newKey): Rename the oldKey to newKey.
• cache.del(key): Delete the value for the given key.
• cache.keys(): Get an array of all valid keys.
• cache.clear(): Clear the entire cache.
• cache.size(): Get the number of valid keys in the cache.
• cache.touch(key, ttlSec): Extend the TTL for the given key.
• cache.has(key): Check if the given key exists in the cache.
• createStore(): Create a new custom cache store.
• expressSessionStore(options): Create an adapter for the express-session package.

Contributing

Contributions to the mini-cache-ttl project are welcome. Please follow the standard GitHub workflow:

1. Fork the repository
2. Create a new branch for your feature or bug fix
3. Implement your changes
4. Submit a pull request

License

The mini-cache-ttl package is licensed under the MIT License.