Class WriteBehindReadAsideCache<K, V, N, CacheTag>`Abstract`

Write‑behind read‑aside cache.

Writes update the source and then fire‑and‑forget a cache store. Reads (wrap) check the cache but never populate it.

Type Parameters

K
V
N extends string
CacheTag extends string = string

Hierarchy (View Summary)

ReadAsideCache<K, V, CacheTag, true, N>
- WriteBehindReadAsideCache

Implements

CacheInterface<K, V, CacheTag, true, N>

Index

Constructors

constructor

new WriteBehindReadAsideCache<
    K,
    V,
    N extends string,
    CacheTag extends string = string,
>(
    name: N,
    store: CacheStoreInterface<K, V>,
    tags: "all" | readonly CacheTagMatcher[],
    defaultTtl?: number | (() => number | Promise<number>),
    onInvalidationFailure?: OnInvalidationFailure,
): WriteBehindReadAsideCache<K, V, N, CacheTag>
Type Parameters
- K
- V
- N extends string
- CacheTag extends string = string
Parameters
- name: N
- store: CacheStoreInterface<K, V>
- tags: "all" | readonly CacheTagMatcher[]
- OptionaldefaultTtl: number | (() => number | Promise<number>)
- OptionalonInvalidationFailure: OnInvalidationFailure
Returns WriteBehindReadAsideCache<K, V, N, CacheTag>
Inherited from ReadAsideCache.constructor
- Defined in src/caching/cache/base-cache.model.ts:42

Properties

`Readonly`_writeResultAvailable

_writeResultAvailable: true

Phantom carrier, only for type inference.

`Optional` `Readonly`defaultTtl

defaultTtl?: number | (() => number | Promise<number>)

The default time to live for a cached value.

`Readonly`name

name: N

The name of the cache. Should be unique.

`Optional` `Readonly`onInvalidationFailure

onInvalidationFailure?: OnInvalidationFailure

Whether to throw when invalidation fails or to just log and ignore.

`Readonly`store

store: CacheStoreInterface<K, V>

The store used by this cache.

`Readonly`tags

tags: "all" | readonly CacheTagMatcher[]

The tags that any values inside of this cache might have.

This is used for performance improvements, to skip caches for invalidateTags if the given tag will never be inside any of the cached values. Can be set to 'all' to check every time.

Methods

setDirect

setDirect(
    key: K,
    value: V,
    options?: CacheSetDirectOptions<CacheTag>,
): Promise<void>
Directly write a value into this cache, following its configured write strategy.

Use this instead of wrapWrite when the source function has already been called and you only need to propagate the result.
Parameters
- key: K
- value: V
- Optionaloptions: CacheSetDirectOptions<CacheTag>
Returns Promise<void>
Implementation of CacheInterface.setDirect
Overrides ReadAsideCache.setDirect
- Defined in src/caching/cache/read-aside/write-behind-read-aside.cache.ts:77

wrap

wrap<TArgs extends unknown[]>(
    fn: (...args: TArgs) => V | Promise<V>,
    keyFn: CacheKeyProvider<K, TArgs>,
    options?: CacheWrapOptions<V, TArgs, CacheTag>,
): (...args: TArgs) => Promise<V>
Type Parameters
- TArgs extends unknown[]
Parameters
- fn: (...args: TArgs) => V | Promise<V>
- keyFn: CacheKeyProvider<K, TArgs>
- Optionaloptions: CacheWrapOptions<V, TArgs, CacheTag>
Returns (...args: TArgs) => Promise<V>
Implementation of CacheInterface.wrap
Inherited from ReadAsideCache.wrap
- Defined in src/caching/cache/read-aside/read-aside.cache.ts:26

wrapDelete

wrapDelete<TReturn, TArgs extends unknown[]>(
    fn: (...args: TArgs) => TReturn | Promise<TReturn>,
    keyFn: CacheKeyProvider<K, TArgs>,
    options?: CacheWrapDeleteOptions<TArgs, CacheTag>,
): (...args: TArgs) => Promise<TReturn>
Returns a wrapped version of fn that invalidates a cache entry after call.
Type Parameters
- TReturn
- TArgs extends unknown[]
Parameters
- fn: (...args: TArgs) => TReturn | Promise<TReturn>
- keyFn: CacheKeyProvider<K, TArgs>
- Optionaloptions: CacheWrapDeleteOptions<TArgs, CacheTag>
Returns (...args: TArgs) => Promise<TReturn>
Implementation of CacheInterface.wrapDelete
Inherited from ReadAsideCache.wrapDelete
- Defined in src/caching/cache/base-cache.model.ts:51

wrapInvalidate

wrapInvalidate<TReturn, TArgs extends unknown[]>(
fn: (...args: TArgs) => TReturn | Promise<TReturn>,
options: CacheWrapInvalidateOptions<TArgs, CacheTag>,
): (...args: TArgs) => Promise<TReturn>
Calls fn → Invalidates tags → Returns the fn result. For operations that affect cached data but produce no cacheable result, e.g. CreateAll/updateAll on a collection cache where no filter key can be derived from the output.
Type Parameters
- TReturn
- TArgs extends unknown[]
Parameters
- fn: (...args: TArgs) => TReturn | Promise<TReturn>
- options: CacheWrapInvalidateOptions<TArgs, CacheTag>
Returns (...args: TArgs) => Promise<TReturn>
Implementation of CacheInterface.wrapInvalidate
Inherited from ReadAsideCache.wrapInvalidate
- Defined in src/caching/cache/base-cache.model.ts:93

wrapWrite

wrapWrite<TArgs extends unknown[]>(
    fn: (...args: TArgs) => V | Promise<V>,
    keyFn: ResultCacheKeyProvider<K, V, TArgs>,
    options?: CacheWrapWriteOptionsWithResult<V, TArgs, CacheTag>,
): (...args: TArgs) => Promise<V>
Returns a wrapped version of fn that writes its result into the cache. Key is derived from the result, not the args — handles the create-with-generated-id case cleanly.
Type Parameters
- TArgs extends unknown[]
Parameters
- fn: (...args: TArgs) => V | Promise<V>
- keyFn: ResultCacheKeyProvider<K, V, TArgs>
- Optionaloptions: CacheWrapWriteOptionsWithResult<V, TArgs, CacheTag>
Returns (...args: TArgs) => Promise<V>
Implementation of CacheInterface.wrapWrite
- Defined in src/caching/cache/read-aside/write-behind-read-aside.cache.ts:22

Class WriteBehindReadAsideCache<K, V, N, CacheTag>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WriteBehindReadAsideCache<K, V, N, CacheTag>

Properties

Readonly_writeResultAvailable

Optional ReadonlydefaultTtl

Readonlyname

Optional ReadonlyonInvalidationFailure

Readonlystore

Readonlytags

Methods

setDirect

Parameters

Returns Promise<void>

wrap

Type Parameters

Parameters

Returns (...args: TArgs) => Promise<V>

wrapDelete

Type Parameters

Parameters

Returns (...args: TArgs) => Promise<TReturn>

wrapInvalidate

Type Parameters

Parameters

Returns (...args: TArgs) => Promise<TReturn>

wrapWrite

Type Parameters

Parameters

Returns (...args: TArgs) => Promise<V>

Settings

On This Page

Class WriteBehindReadAsideCache<K, V, N, CacheTag>`Abstract`

`Readonly`_writeResultAvailable

`Optional` `Readonly`defaultTtl

`Readonly`name

`Optional` `Readonly`onInvalidationFailure

`Readonly`store

`Readonly`tags