Class MemoryCacheAdapter<TType>

The MemoryCacheAdapter is used for easily fakingICache for testing.

IMPORT_PATH: "@daiso-tech/core/cache/memory-cache-adapter"

Type Parameters

TType = unknown

Implements

ICacheAdapter<TType>

Index

Constructors

constructor

Methods

add get getAndRemove getOrAdd increment put removeAll removeByKeyPrefix removeMany update

Constructors

constructor

new MemoryCacheAdapter<TType = unknown>(
map?: Map<string, unknown>,
): MemoryCacheAdapter<TType>
You can provide an optional Map | Map, that will be used for storing the data.
Type Parameters
- TType = unknown
Parameters
- map: Map<string, unknown> = ...
Returns MemoryCacheAdapter<TType>
Example
```
import { MemoryCacheAdapter } from "@daiso-tech/core/cache/memory-cache-adapter";

const map = new Map<any, any>();
const cacheAdapter = new MemoryCacheAdapter(map);
```
- Defined in src/cache/implementations/adapters/memory-cache-adapter/memory-cache-adapter.ts:37

Methods

add

add(
    key: string,
    value: TType,
    ttl: null | TimeSpan,
    context: IReadableContext,
): Promise<boolean>
Creates a new cache entry, but only if the key does not already exist. Has no effect if the key already exists.
Parameters
- key: string
  Cache key to add
- value: TType
  Value to cache
- ttl: null | TimeSpan
  Time-to-live duration for this entry. Pass null to cache without expiration.
- context: IReadableContext
  Readable execution context for the operation
Returns Promise<boolean>
true if the entry was created, false if the key already existed
Implementation of ICacheAdapter.add
- Defined in src/cache/implementations/adapters/memory-cache-adapter/memory-cache-adapter.ts:43

get

get(key: string, context: IReadableContext): Promise<null | TType>
Retrieves a value by key without removing it.
Parameters
- key: string
  Cache key to retrieve
- context: IReadableContext
  Readable execution context for the operation
Returns Promise<null | TType>
The cached value, or null if not found or expired
Implementation of ICacheAdapter.get
- Defined in src/cache/implementations/adapters/memory-cache-adapter/memory-cache-adapter.ts:39

getAndRemove

getAndRemove(key: string, context: IReadableContext): Promise<null | TType>
Retrieves a value by key and immediately removes it. Useful for one-time-use values (tokens, temporary states, etc.).
Parameters
- key: string
  Cache key to retrieve and remove
- context: IReadableContext
  Readable execution context for the operation
Returns Promise<null | TType>
The cached value, or null if not found or expired
Implementation of ICacheAdapter.getAndRemove
- Defined in src/cache/implementations/adapters/memory-cache-adapter/memory-cache-adapter.ts:75

getOrAdd

getOrAdd(
    key: string,
    valueToAdd: TType,
    ttl: null | TimeSpan,
    context: IReadableContext,
): Promise<TType>
The getOrAdd method retrieves the value for the given key if it exists, otherwise adds the valueToAdd to the cache and returns it.
Parameters
- key: string
  The cache key to retrieve or add.
- valueToAdd: TType
  The value to store if the key is not found.
- ttl: null | TimeSpan
  Optional time-to-live for the cached item. If null is passed, the item will not expire.
- context: IReadableContext
  Readable execution context for the operation
Returns Promise<TType>
The cached value if the key exists, or the newly added value.
Implementation of ICacheAdapter.getOrAdd
- Defined in src/cache/implementations/adapters/memory-cache-adapter/memory-cache-adapter.ts:52

increment

increment(
    key: string,
    value: number,
    _context: IReadableContext,
): Promise<boolean>
Increments a numeric cache entry by a given amount. Useful for counters, rates, and statistics.
Parameters
- key: string
  Cache key to increment
- value: number
  Amount to increment by.
- _context: IReadableContext
Returns Promise<boolean>
true if the entry was incremented, false if the key did not exist

Throws
If the cached value is not a number
Implementation of ICacheAdapter.increment
- Defined in src/cache/implementations/adapters/memory-cache-adapter/memory-cache-adapter.ts:129

put

put(
    key: string,
    value: TType,
    ttl: null | TimeSpan,
    context: IReadableContext,
): Promise<boolean>
Creates a new cache entry or updates an existing one (upsert). Also updates the TTL when overwriting an existing entry.
Parameters
- key: string
  Cache key to set
- value: TType
  Value to cache
- ttl: null | TimeSpan
  Time-to-live duration for this entry. Pass null to cache without expiration.
- context: IReadableContext
  Readable execution context for the operation
Returns Promise<boolean>
true if the entry was added, false if it was updated
Implementation of ICacheAdapter.put
- Defined in src/cache/implementations/adapters/memory-cache-adapter/memory-cache-adapter.ts:106

removeAll

removeAll(): Promise<void>
Removes all cache entries. Use with caution as this completely clears the cache.

Returns Promise<void>
Implementation of ICacheAdapter.removeAll
- Defined in src/cache/implementations/adapters/memory-cache-adapter/memory-cache-adapter.ts:170

removeByKeyPrefix

removeByKeyPrefix(prefix: string, _context: IReadableContext): Promise<void>
Removes all cache entries whose keys start with a given prefix. Useful for invalidating groups of related cache entries.
Parameters
- prefix: string
  Key prefix to match for removal
- _context: IReadableContext
Returns Promise<void>
Implementation of ICacheAdapter.removeByKeyPrefix
- Defined in src/cache/implementations/adapters/memory-cache-adapter/memory-cache-adapter.ts:176

removeMany

removeMany(keys: string[], _context: IReadableContext): Promise<boolean>
Removes multiple cache entries at once.
Parameters
- keys: string[]
  Array of cache keys to remove
- _context: IReadableContext
Returns Promise<boolean>
true if at least one key was removed, false if none existed
Implementation of ICacheAdapter.removeMany
- Defined in src/cache/implementations/adapters/memory-cache-adapter/memory-cache-adapter.ts:154

update

update(key: string, value: TType, _context: IReadableContext): Promise<boolean>
Updates an existing cache entry without changing its TTL. Has no effect if the key does not exist.
Parameters
- key: string
  Cache key to update
- value: TType
  New value to cache
- _context: IReadableContext
Returns Promise<boolean>
true if the entry was updated, false if the key did not exist
Implementation of ICacheAdapter.update
- Defined in src/cache/implementations/adapters/memory-cache-adapter/memory-cache-adapter.ts:117

Class MemoryCacheAdapter<TType>

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MemoryCacheAdapter<TType>

Example

Methods

add

Parameters

Returns Promise<boolean>

get

Parameters

Returns Promise<null | TType>

getAndRemove

Parameters

Returns Promise<null | TType>

getOrAdd

Parameters

Returns Promise<TType>

increment

Parameters

Returns Promise<boolean>

Throws

put

Parameters

Returns Promise<boolean>

removeAll

Returns Promise<void>

removeByKeyPrefix

Parameters

Returns Promise<void>

removeMany

Parameters

Returns Promise<boolean>

update

Parameters

Returns Promise<boolean>

Settings

On This Page