Class ALSBase<K, V, S>`Protected` `Abstract`

A base class from which the modern and legacy APIs are both derived.

Type Parameters

K
V
S extends Dictionary<K, V>

Hierarchy (View Summary)

ALSBase
- ALS
- Namespace

Index

Constructors

Instance Methods

createStore getStore get set bind enterWith

Properties

asyncLocalStorage

Constructors

constructor

new ALSBase<K, V, S extends Map<K, V> | MapLike<K, V> | Record<K<K>, V>>(): ALSBase<
    K,
    V,
    S,
>
Type Parameters
- K
- V
- S extends Map<K, V> | MapLike<K, V> | Record<K<K>, V>
Returns ALSBase<K, V, S>
- Defined in src/util/als.base.ts:11

Instance Methods

`Protected` `Abstract`createStore

createStore(defaults?: Dictionary<K, V>): S
Parameters
- Optionaldefaults: Dictionary<K, V>
Returns S
- Defined in src/util/als.base.ts:15

getStore

getStore(): undefined | S
Retrieves the current store.

Returns undefined | S
The current store or undefined if there is no store.
- Defined in src/util/als.base.ts:21

get

get<T = V>(key: K): undefined | T
Retrieves a value from the store by key.
Type Parameters
- T = V
Parameters
- key: K
  The key to retrieve the value for.
Returns undefined | T
The value associated with the key, or undefined if the key does not exist.
- Defined in src/util/als.base.ts:30

set

set<T = V>(key: K, value: T): void
Sets a value in the store by key.
Type Parameters
- T = V
Parameters
- key: K
  The key to set the value for.
- value: T
  The value to set.
Returns void
- Defined in src/util/als.base.ts:40

bind

bind<T extends () => any>(fn: T): T
Experimental
Binds a function to the current store context. Marked experimental as it depends on AsyncLocalStorage.bind
Type Parameters
- T extends () => any
Parameters
- fn: T
  The function to bind.
Returns T
The bound function.
- Defined in src/util/als.base.ts:54

`Protected`enterWith

enterWith(defaults?: Dictionary<K, V>): void
Experimental
Enters a new store context with the given default values. Marked experimental as it depends on AsyncLocalStorage#enterWith
Parameters
- Optionaldefaults: Dictionary<K, V>
  The default values to initialize the store with.
Returns void
- Defined in src/util/als.base.ts:64

Properties

`Protected`asyncLocalStorage

asyncLocalStorage: AsyncLocalStorage<S>