Class RxMap<K, V, T>

Extension of the standard ES6 Map with rxjs change event observables tacked on.

Type parameters

K
V
T: Map<K, V> = Map<K, V>

Hierarchy

RxMap

Implements

Map<K, V>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new RxMap<K, V, T>(source: T): RxMap<K, V, T>

- Defined in maps/rx-map.ts:26
Type parameters
- K
- V
- T: Map<K, V, T> = Map<K, V>
Parameters
- source: T
Returns RxMap<K, V, T>

Properties

Readonly allChanges

allChanges: Observable<MapStateChangeEvent<K, V>> = ...

Readonly changes

changes: Observable<MapStateChangeEvent<K, V>> = ...

Protected Readonly mStateChangeSubject

mStateChangeSubject: Subject<MapStateChangeEvent<K, V>> = ...

Protected Readonly source

source: T

Accessors

[Symbol.toStringTag]

get [Symbol.toStringTag](): string

- Defined in maps/rx-map.ts:67
Returns string

size

get size(): number

- Defined in maps/rx-map.ts:63
Returns number

Methods

[Symbol.iterator]

[Symbol.iterator](): IterableIterator<[K, V]>

Implementation of Map.__@iterator
- Defined in maps/rx-map.ts:71
Returns IterableIterator<[K, V]>

clear

clear(): void

Implementation of Map.clear
- Defined in maps/rx-map.ts:106
Returns void

delete

delete(key: K, context?: MapStateChangeEventContext): boolean

Implementation of Map.delete
- Defined in maps/rx-map.ts:111
Parameters
- key: K
- Optional context: MapStateChangeEventContext
Returns boolean

destroy

destroy(): void

- Defined in maps/rx-map.ts:99
Returns void

Protected emit

emit(type: MapStateChangeEventType, key: K, value?: V, previousValue?: Partial<V>, context?: MapStateChangeEventContext): void

- Defined in maps/rx-map.ts:45
Parameters
- type: MapStateChangeEventType
- key: K
- Optional value: V
- Optional previousValue: Partial<V>
- context: MapStateChangeEventContext = ...
Returns void

Protected emitDelete

emitDelete(key: K, value: V, context?: MapStateChangeEventContext): void

- Defined in maps/rx-map.ts:59
Parameters
- key: K
- value: V
- Optional context: MapStateChangeEventContext
Returns void

Protected emitSet

emitSet(key: K, value: V, previousValue?: V, context?: MapStateChangeEventContext): void

- Defined in maps/rx-map.ts:55
Parameters
- key: K
- value: V
- Optional previousValue: V
- Optional context: MapStateChangeEventContext
Returns void

entries

entries(): IterableIterator<[K, V]>

Implementation of Map.entries
- Defined in maps/rx-map.ts:83
Returns IterableIterator<[K, V]>

forEach

forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void): void

Implementation of Map.forEach
- Defined in maps/rx-map.ts:95
Parameters
- callbackfn: (value: V, key: K, map: Map<K, V>) => void
  - - (value: V, key: K, map: Map<K, V>): void
    - Parameters
      - value: V
      - key: K
      - map: Map<K, V>
      Returns void
Returns void

get

get(key: K): undefined | V

Implementation of Map.get
- Defined in maps/rx-map.ts:75
Parameters
- key: K
Returns undefined | V

has

has(key: K): boolean

Implementation of Map.has
- Defined in maps/rx-map.ts:79
Parameters
- key: K
Returns boolean

keys

keys(): IterableIterator<K>

Implementation of Map.keys
- Defined in maps/rx-map.ts:87
Returns IterableIterator<K>

set

set(key: K, value: V, context?: MapStateChangeEventContext): RxMap<K, V, T>

Implementation of Map.set
- Defined in maps/rx-map.ts:118
Parameters
- key: K
- value: V
- Optional context: MapStateChangeEventContext
Returns RxMap<K, V, T>

values

values(): IterableIterator<V>

Implementation of Map.values
- Defined in maps/rx-map.ts:91
Returns IterableIterator<V>

Static immutable

immutable<K1, V1>(): RxMap<K1, V1, ImmutableMap<K1, V1>>

- Defined in maps/rx-map.ts:41
Generate an RxMap instance with an immutable backend store.

Type parameters
- K1
- V1
Returns RxMap<K1, V1, ImmutableMap<K1, V1>>

Static mutable

mutable<K1, V1>(): RxMap<K1, V1, Map<K1, V1>>

- Defined in maps/rx-map.ts:34
Generate an RxMap instance with a standard (mutable) Map store.

Type parameters
- K1
- V1
Returns RxMap<K1, V1, Map<K1, V1>>

Generated using TypeDoc