Class default<V, K>

Implementation for a simple in-memory cache data structure

Type parameters

V = unknown

value type
K = string

key type (string by default)

Hierarchy

default
- default

Implements

default<V, K>

Index

Constructors

constructor

Properties

storage

Accessors

size

Methods

Constructors

constructor

new default<V, K>(): default<V, K>

Type parameters
- V = unknown
- K = string
Returns default<V, K>

Properties

Protected Readonly storage

storage: Map<K, V> = ...

Cache object

Accessors

size

get size(): number

Implementation of default.size
- Defined in src/core/cache/simple/index.ts:27
see
[[Cache.size]]

Returns number

Methods

[iterator]

[iterator](): IterableIterator<K>

Implementation of default.[iterator]
- Defined in src/core/cache/simple/index.ts:36
Returns an iterator by the cache keys

Returns IterableIterator<K>

clear

clear(filter?: ClearFilter<V, K>): Map<K, V>

Implementation of default.clear
- Defined in src/core/cache/simple/index.ts:81
see
[[Cache.clear]]

Parameters
- Optional filter: ClearFilter<V, K>
Returns Map<K, V>

entries

entries(): IterableIterator<[K, V]>

Implementation of default.entries
- Defined in src/core/cache/simple/index.ts:76
see
[[Cache.entries]]

Returns IterableIterator<[K, V]>

get

get(key: K): CanUndef<V>

Implementation of default.get
- Defined in src/core/cache/simple/index.ts:46
see
[[Cache.get]]

Parameters
- key: K
Returns CanUndef<V>

has

has(key: K): boolean

Implementation of default.has
- Defined in src/core/cache/simple/index.ts:41
see
[[Cache.has]]

Parameters
- key: K
Returns boolean

keys

keys(): IterableIterator<K>

Implementation of default.keys
- Defined in src/core/cache/simple/index.ts:66
see
[[Cache.keys]]

Returns IterableIterator<K>

remove

remove(key: K): CanUndef<V>

Implementation of default.remove
- Defined in src/core/cache/simple/index.ts:57
see
[[Cache.remove]]

Parameters
- key: K
Returns CanUndef<V>

set

set(key: K, value: V): V

Implementation of default.set
- Defined in src/core/cache/simple/index.ts:51
see
[[Cache.set]]

Parameters
- key: K
- value: V
Returns V

values

values(): IterableIterator<V>

Implementation of default.values
- Defined in src/core/cache/simple/index.ts:71
see
[[Cache.values]]

Returns IterableIterator<V>