Class AlsUtilities`Abstract`

Encapsulates functionality around async local storage.

Index

Constructors

Methods

getCurrentCacheContext getCurrentRequestContext runWithCacheContext runWithHttpRequestContext runWithWebsocketRequestContext

Constructors

constructor

new AlsUtilities(): AlsUtilities
Returns AlsUtilities

Methods

`Static`getCurrentCacheContext

getCurrentCacheContext(): CacheContext[] | undefined
Resolves the currently active cache context from the async local storage.

Returns CacheContext[] | undefined
The currently active cache context.

Throws
When the async local storage store has not been initialized yet.
- Defined in src/context/als.utilities.ts:81

`Static`getCurrentRequestContext

getCurrentRequestContext(): | HttpRequestContext
| WebsocketRequestContext
| undefined
Resolves the currently active request context from the async local storage.

Returns HttpRequestContext | WebsocketRequestContext | undefined
The currently active request context.

Throws
When the async local storage store has not been initialized yet.
- Defined in src/context/als.utilities.ts:20

`Static`runWithCacheContext

runWithCacheContext<T>(context: CacheContext, fn: () => T): T
Runs the given function with the cache context saved in async local storage.
Type Parameters
- T
Parameters
- context: CacheContext
  The cache context.
- fn: () => T
  The function to run.
Returns T
The result of the function.
- Defined in src/context/als.utilities.ts:70

`Static`runWithHttpRequestContext

runWithHttpRequestContext<T>(context: HttpRequestContext, fn: () => T): T
Runs the given function with the request context saved in async local storage.
Type Parameters
- T
Parameters
- context: HttpRequestContext
  The request context.
- fn: () => T
  The function to run.
Returns T
The result of the function.
- Defined in src/context/als.utilities.ts:30

`Static`runWithWebsocketRequestContext

runWithWebsocketRequestContext<T>(
context: WebsocketRequestContext,
fn: () => T,
): T
Runs the given function with the request context saved in async local storage.
Type Parameters
- T
Parameters
- context: WebsocketRequestContext
  The request context.
- fn: () => T
  The function to run.
Returns T
The result of the function.
- Defined in src/context/als.utilities.ts:50