bandcamp-fetch/docs/api/classes/Cache.md

bandcamp-fetch / Cache

Class: Cache

Table of contents

Constructors

• constructor

Methods

• clear
• get
• getKeys
• getMaxEntries
• getOrSet
• put
• reduceEntries
• setMaxEntries
• setTTL

Constructors

constructor

• new Cache(ttl, maxEntries)

Parameters

Name	Type
ttl	Record<CacheDataType, number>
maxEntries	Record<string, number>

Defined in

lib/utils/Cache.ts:13

Methods

clear

▸ clear(type?): void

Parameters

Name	Type
type?	CacheDataType

Returns

void

Defined in

lib/utils/Cache.ts:74

---

get

▸ get<T>(type, key): undefined | T

Type parameters

Name
T

Parameters

Name	Type
type	CacheDataType
key	string

Returns

undefined | T

Defined in

lib/utils/Cache.ts:39

---

getKeys

▸ getKeys(type): string[]

Parameters

Name	Type
type	CacheDataType

Returns

string[]

Defined in

lib/utils/Cache.ts:70

---

getMaxEntries

▸ getMaxEntries(type): number

Parameters

Name	Type
type	CacheDataType

Returns

number

Defined in

lib/utils/Cache.ts:35

---

getOrSet

▸ getOrSet<T>(type, key, promiseCallback): Promise<T>

Type parameters

Name
T

Parameters

Name	Type
type	CacheDataType
key	string
promiseCallback	() => Promise<T>

Returns

Promise<T>

Defined in

lib/utils/Cache.ts:85

---

put

▸ put<T>(type, key, value): boolean

Type parameters

Name
T

Parameters

Name	Type
type	CacheDataType
key	string
value	T

Returns

boolean

Defined in

lib/utils/Cache.ts:43

---

reduceEntries

▸ reduceEntries(type, reduceTo?): void

Parameters

Name	Type
type	CacheDataType
reduceTo?	number

Returns

void

Defined in

lib/utils/Cache.ts:58

---

setMaxEntries

▸ setMaxEntries(type, maxEntries): void

Parameters

Name	Type
type	CacheDataType
maxEntries	number

Returns

void

Defined in

lib/utils/Cache.ts:30

---

setTTL

▸ setTTL(type, ttl): void

Parameters

Name	Type
type	CacheDataType
ttl	number

Returns

void

Defined in

lib/utils/Cache.ts:21