Class Cache

The cache.

Implements

MemoryUsage

Index

Constructors

Accessors

capacity count defaultTtl enabled maxSize size

Methods

clear delete entries get getMemoryUsage purge set

Constructors

constructor

new Cache(opts?): Cache
Constructs a cache.
Parameters
- opts: {
      byteCapacity?: number;
      maxNumberOfEntries?: number;
      ttl?: number;
  } = ...
  The options.
  - Optional byteCapacity?: number
    The capacity, in bytes, of the cache.
  - Optional maxNumberOfEntries?: number
    The capacity, in number of entries, of the cache.
  - Optional ttl?: number
    The default TTL (time to live) of entries. Can be overriden for each entry (see CacheOptions).
Returns Cache
- Defined in core/Cache.ts:59

Accessors

capacity

get capacity(): number
Gets the maximum number of entries.

Returns number
- Defined in core/Cache.ts:132

count

get count(): number
Gets the number of entries.

Returns number
- Defined in core/Cache.ts:139

defaultTtl

get defaultTtl(): number
Gets or sets the default TTL (time to live) of the cache.

Returns number
- Defined in core/Cache.ts:114
set defaultTtl(v): void
Parameters
- v: number
Returns void
- Defined in core/Cache.ts:118

enabled

get enabled(): boolean
Enables or disables the cache.

Returns boolean
- Defined in core/Cache.ts:103
set enabled(v): void
Parameters
- v: boolean
Returns void
- Defined in core/Cache.ts:107

maxSize

get maxSize(): number
Gets the maximum size of the cache, in bytes.

Returns number
- Defined in core/Cache.ts:125

size

get size(): number
Gets the size of entries, in bytes

Returns number
- Defined in core/Cache.ts:146

Methods

clear

clear(): void
Clears the cache.

Returns void
- Defined in core/Cache.ts:228

delete

delete(key): boolean
Deletes an entry.
Parameters
- key: string
  The key.
Returns boolean
true if the entry was deleted, false otherwise.
- Defined in core/Cache.ts:220

entries

entries(): unknown[]
Returns an array of entries.

Returns unknown[]
- Defined in core/Cache.ts:153

get

get(key): unknown
Returns the entry with the specified key, or undefined if no entry matches this key.
Parameters
- key: string
  The entry key.
Returns unknown
The entry, or undefined.
- Defined in core/Cache.ts:178

getMemoryUsage

getMemoryUsage(_context, target?): MemoryUsageReport
Returns an approximation of the memory used by this object, in bytes.
Parameters
- _context: GetMemoryUsageContext
  The graphics context.
- Optional target: MemoryUsageReport
  If specified, the values computed during this call must be added to the existing values in the target. Otherwise, a new report must be built.
Returns MemoryUsageReport
The memory usage report. If target is specified, then this must be returned.
Implementation of MemoryUsage.getMemoryUsage
- Defined in core/Cache.ts:92

purge

purge(): void
Removes stale entries.

Returns void
- Defined in core/Cache.ts:168

set

set(key, value, options?): unknown
Stores an entry in the cache, or replaces an existing entry with the same key.
Parameters
- key: string
  The key.
- value: unknown
  The value.
- options: CacheOptions = {}
  The options.
Returns unknown
- Defined in core/Cache.ts:193