Class AsyncMap<T>

Type Parameters

T = unknown

Hierarchy

AsyncMap

Index

Constructors

Properties

_distributer _map

Accessors

Methods

delete get has set subscribe unsubscribe waitGet

Constructors

constructor

new AsyncMap<T>(distributor: Distributor<{
key: string;
value: T;
}>): AsyncMap<T>
Type Parameters
- T = unknown
Parameters
- distributor: Distributor<{
  key: string;
  value: T;
  }>
Returns AsyncMap<T>
- Defined in moirae/core/lib/classes/async-map.class.ts:10

Properties

`Private` `Readonly` _distributer

_distributer: Distributor<{
key: string;
value: T;
}>

`Private` `Readonly` _map

_map: Map<string, T>

Accessors

size

get size(): number
Returns number
- Defined in moirae/core/lib/classes/async-map.class.ts:15

Methods

delete

delete(key: string): void
Remove the specified key from the map
Parameters
- key: string
Returns void
- Defined in moirae/core/lib/classes/async-map.class.ts:22

get

get(key: string, defaultValue?: T): T
Get a key from the map. Will return undefined if not found.
Parameters
- key: string
  
  Key to find
- Optional defaultValue: T
  
  Value to use if key is not found
Returns T
- Defined in moirae/core/lib/classes/async-map.class.ts:32

has

has(key: string): boolean
Check if key is existing in the map
Parameters
- key: string
Returns boolean
- Defined in moirae/core/lib/classes/async-map.class.ts:39

set

set(key: string, value: T): void
Set the value of a key in the map
Parameters
- key: string
- value: T
Returns void
- Defined in moirae/core/lib/classes/async-map.class.ts:46

subscribe

subscribe(handlerFn: ((event: {
key: string;
value: T;
}) => void)): string
Parameters
- handlerFn: ((event: {
  key: string;
  value: T;
  }) => void)
  - - (event: {
      key: string;
      value: T;
      }): void
    - Parameters
      
      event: {
      key: string;
      value: T;
      }
      
      key: string
      
      value: T
      
      Returns void
Returns string
- Defined in moirae/core/lib/classes/async-map.class.ts:52

unsubscribe

unsubscribe(id: string): void
Parameters
- id: string
Returns void
- Defined in moirae/core/lib/classes/async-map.class.ts:58

waitGet

waitGet(key: string, timeout?: number): Promise<T>
Asynchronously wait for a key to be inserted into the map. Will persist the key in the map in addition to returning it.
Parameters
- key: string
  
  Key to wait for
- timeout: number = 5000
  
  Timeout before error is thrown in ms
Returns Promise<T>
- Defined in moirae/core/lib/classes/async-map.class.ts:69

Generated using TypeDoc