Class GlobalRegistry

A convenient class to manage global variables.

Hierarchy

GlobalRegistry

Index

Constructors

Properties

override? storage

Methods

enter forceContextOverride getCollection getGlobal run setGlobal

Constructors

constructor

new GlobalRegistry(): GlobalRegistry
Returns GlobalRegistry

Properties

`Protected` `Optional` override

override?: Collection<GlobalRegistrant>

`Protected` `Readonly` storage

storage: AsyncLocalStorage<Collection<GlobalRegistrant>> = ...

Methods

enter

enter(): GlobalRegistry
Initialize the global registry in the current sync context.

Returns GlobalRegistry
- Defined in src/util/support/global.ts:33

forceContextOverride

forceContextOverride(): GlobalRegistry
Force the current globals to be the global defaults for ALL contexts.

Returns GlobalRegistry
- Defined in src/util/support/global.ts:39

`Protected` getCollection

getCollection(): Collection<GlobalRegistrant>
Get the globals collection or throw an error if outside async context.

Returns Collection<GlobalRegistrant>
- Defined in src/util/support/global.ts:72

getGlobal

getGlobal(key: string | symbol): any
Retrieve the value of the given key, if it exists in the store.
Parameters
- key: string | symbol
Returns any
- Defined in src/util/support/global.ts:67

run

run<T>(closure: (() => T)): T
Run a closure with a global registry.
Type Parameters
- T
Parameters
- closure: (() => T)
  - - (): T
    - Returns T
Returns T
- Defined in src/util/support/global.ts:25

setGlobal

setGlobal(key: string | symbol, value: unknown): GlobalRegistry
Store the given value associated by key.
Parameters
- key: string | symbol
- value: unknown
Returns GlobalRegistry
- Defined in src/util/support/global.ts:49