@avanio/expire-cache

@avanio/expire-cache

Typescript/Javascript Cache interfaces and expiration cache class.

This package contains:

• ICache common cache interface
• IAsyncCache common async cache interface
• TAnyCache type for both common cache interfaces
• ExpireCache class which implements ICache interface with value expiration

examples

Synchronous example

import {ICache, ExpireCache} from '@avanio/expire-cache';

const cache = new ExpireCache<string>();

cache.add('key', 'value', new Date(Date.now() + 1000)); // expires 1000ms
cache.add('key2', 'value2'); // never expires (if no default expiration is set)

cache.get('key'); // 'value'

cache.delete('key');

cache.clear();

function useCache(cache: ICache<string>) {
	const value = cache.get('key'); // 'value'
}

Synchronous/Asynchronous example (works with both ICache and IAsyncCache interfaces)

import {TAnyCache} from '@avanio/expire-cache';

function useCache(cache: TAnyCache<string>) {
	const value = await cache.get('key'); // 'value'
}

Advanced logging example, see default log levels

const cache = new ExpireCache<string>(console, {
	get: LogLevel.Info,
	set: LogLevel.Info,
});

(optional) default expiration in milliseconds if not specified in add() method. (if both are undefined, cache entry never expires)

const cache = new ExpireCache<string>(console, undefined, 60 * 1000); // sets default 60 seconds expiration for add() method