Package Exports
- @j-mori/lambda-cache
- @j-mori/lambda-cache/dist/cjs/index.js
- @j-mori/lambda-cache/dist/esm/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@j-mori/lambda-cache) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
lambda-cache
A simple, fast, cheap, lightweight dependency-less and cross execution cache system for AWS Lambda functions, based on writing to files in the "/tmp" folder. It allows you to set a time-to-live (TTL) for cache keys and invalidate the cache.
Installation
You can install the package via npm:
npm install @j-mori/lambda-cacheUsage
import { Cache } from 'lambda-cache';
// Create a new cache with the default base path /tmp/cache
const cache = new Cache();
// Set a value
cache.set('key', 'value', 10); // expires in 10 seconds
// Get a value
console.log(cache.get('key'));
// Delete a value
cache.delete('key');
// Clear all values
cache.clear();
API
new Cache(path?: string)
Creates a new cache instance that stores the data in the specified path.
path(optional): the path where the cache files will be stored.
cache.set(key: string, value: any, ttl?: number)
Stores a value in the cache.
key: the key used to store and retrieve the value.value: the value to store.ttl(optional): the time to live for this cache entry in seconds. If not provided, the key won't expire.
cache.get(key: string)
Retrieves a value from the cache.
key: the key used to store the value.
Returns the stored value or undefined if the key does not exist or the value has expired.
cache.delete(key: string)
Deletes a value from the cache.
key: the key used to store the value.
cache.clear()
Clears all the values from the cache.