@avanio/expire-cache

!github action

Typescript/Javascript cache interfaces and expiration cache class.

This package contains:

- _ICache_ a common cache interface
- _IAsyncCache_ a common async cache interface
- _ICacheOrAsync_ a type for both cache interfaces
- _ExpireCache_ a class which implements the ICache interface with value expiration

examples

$3

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

const cache = new ExpireCache(); // expiration on read operations
const cache = new ExpireTimeoutCache(); // expiration with setTimeout

cache.onClear((cleared) => {
for (const [key, value] of cleared.entries()) {
console.log(key ${String(key)} expired, deleted or clear with value ${value});
}
});

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

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

cache.has('key'); // true

cache.delete('key');

cache.clear();

cache.size(); // 1

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

$3

`typescript
import {ICacheOrAsync} from '@avanio/expire-cache';

function useCache(cache: ICacheOrAsync) {
const value = await cache.get('key'); // 'value'
}
`

$3

`typescript
const cache = new ExpireCache(console, {
get: LogLevel.Info,
set: LogLevel.Info,
});
`

$3

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