Skip to content

cache

cache

Interfaces

LruCache

Defined in: cache/index.ts:9

Type Parameters

Type Parameter
T

Properties

size
readonly size: number;

Defined in: cache/index.ts:16

Methods

clear()
clear(): void;

Defined in: cache/index.ts:15

Returns

void

delete()
delete(key): boolean;

Defined in: cache/index.ts:14

Parameters
Parameter Type
key string
Returns

boolean

get()
get(key): T | undefined;

Defined in: cache/index.ts:10

Parameters
Parameter Type
key string
Returns

T | undefined

getOrCreate()
getOrCreate(key, factory): T;

Defined in: cache/index.ts:12

Parameters
Parameter Type
key string
factory () => T
Returns

T

has()
has(key): boolean;

Defined in: cache/index.ts:13

Parameters
Parameter Type
key string
Returns

boolean

set()
set(key, value): void;

Defined in: cache/index.ts:11

Parameters
Parameter Type
key string
value T
Returns

void


LruCacheOptions

Defined in: cache/index.ts:1

Type Parameters

Type Parameter
T

Properties

capacity?
optional capacity?: number;

Defined in: cache/index.ts:2

dispose?
optional dispose?: (value, key) => void;

Defined in: cache/index.ts:4

Parameters
Parameter Type
value T
key string
Returns

void

maxSize?
optional maxSize?: number;

Defined in: cache/index.ts:6

sizeCalculation?
optional sizeCalculation?: (value, key) => number;

Defined in: cache/index.ts:5

Parameters
Parameter Type
value T
key string
Returns

number

ttl?
optional ttl?: number;

Defined in: cache/index.ts:3

Functions

dedup()

function dedup<T>(
   cache, 
   key, 
factory): Promise<T>;

Defined in: cache/index.ts:158

Type Parameters

Type Parameter
T

Parameters

Parameter Type
cache LruCache<T>
key string
factory () => T | Promise<T>

Returns

Promise<T>


lru()

function lru<T>(options?): LruCache<T>;

Defined in: cache/index.ts:25

Type Parameters

Type Parameter
T

Parameters

Parameter Type
options LruCacheOptions<T>

Returns

LruCache<T>