Class ObservableMap<K, V>

Type Parameters

Hierarchy

Map<K, V>
Hierarchy
- ObservableMap

Index

Constructors

constructor

new ObservableMap<K, V>(entries?: null | readonly (readonly [K, V])[]): ObservableMap<K, V>
Type Parameters
Type Parameters
- K
- V
Parameters
- Optional entries: null | readonly (readonly [K, V])[]
Returns ObservableMap<K, V>
Inherited from Map<K, V>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:53
new ObservableMap<K, V>(iterable?: null | Iterable<readonly [K, V]>): ObservableMap<K, V>
Type Parameters
Type Parameters
- K
- V
Parameters
- Optional iterable: null | Iterable<readonly [K, V]>
Returns ObservableMap<K, V>
Inherited from Map<K, V>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:161

Properties

`Readonly` [toStringTag]

[toStringTag]: "ObservableMap" = 'ObservableMap'

Methods

asObservable

asObservable(): Observable<ObservableMapEmits<K, V>>
Returns Observable<ObservableMapEmits<K, V>>
- Defined in src/data-structures/maps/observable.ts:126

complete

complete(): void
Returns void
- Defined in src/data-structures/maps/observable.ts:131

delete

delete(key: K): boolean
Parameters
- key: K
Returns boolean
Overrides Map.delete
- Defined in src/data-structures/maps/observable.ts:102

get

get(key: K): undefined | V
Parameters
- key: K
Returns undefined | V
Overrides Map.get
- Defined in src/data-structures/maps/observable.ts:114

has

has(key: K): boolean
Parameters
- key: K
Returns boolean
Overrides Map.has
- Defined in src/data-structures/maps/observable.ts:120

`Protected` notify

notify(event: "set", args: [key: K, value: V], result?: undefined): void
Parameters
- event: "set"
- args: [key: K, value: V]
- Optional result: undefined
Returns void
- Defined in src/data-structures/maps/observable.ts:79
notify(event: "delete", args: [key: K], result: boolean): void
Parameters
- event: "delete"
- args: [key: K]
- result: boolean
Returns void
- Defined in src/data-structures/maps/observable.ts:84
notify(event: "get", args: [key: K], result: undefined | V): void
Parameters
- event: "get"
- args: [key: K]
- result: undefined | V
Returns void
- Defined in src/data-structures/maps/observable.ts:85
notify(event: "has", args: [key: K], result: boolean): void
Parameters
- event: "has"
- args: [key: K]
- result: boolean
Returns void
- Defined in src/data-structures/maps/observable.ts:86

set

set(key: K, value: V): ObservableMap<K, V>
Parameters
- key: K
- value: V
Returns ObservableMap<K, V>
Overrides Map.set
- Defined in src/data-structures/maps/observable.ts:108

`Static` filterEvents

filterEvents<E, K, V>(...eventNames: E[]): OperatorFunction<ObservableMapEmits<K, V>, ObservableMapEmitsFiltered<K, V, E>>
Type Parameters
Type Parameters
- E extends "delete" | "get" | "has" | "set"
- K
- V
Parameters
- Rest ...eventNames: E[]
Returns OperatorFunction<ObservableMapEmits<K, V>, ObservableMapEmitsFiltered<K, V, E>>
- Defined in src/data-structures/maps/observable.ts:53

`Static` ignoreEvents

ignoreEvents<E, K, V>(...eventNames: E[]): OperatorFunction<ObservableMapEmits<K, V>, ObservableMapEmitsIgnored<K, V, E>>
Type Parameters
Type Parameters
- E extends "delete" | "get" | "has" | "set"
- K
- V
Parameters
- Rest ...eventNames: E[]
Returns OperatorFunction<ObservableMapEmits<K, V>, ObservableMapEmitsIgnored<K, V, E>>
- Defined in src/data-structures/maps/observable.ts:64

Class ObservableMap<K, V>

Type Parameters

K

V

Hierarchy

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Type Parameters

K

V

Parameters

Optional entries: null | readonly (readonly [K, V])[]

Returns ObservableMap<K, V>

Type Parameters

Type Parameters

K

V

Parameters

Optional iterable: null | Iterable<readonly [K, V]>

Returns ObservableMap<K, V>

Properties

Readonly [toStringTag]

Methods

asObservable

Returns Observable<ObservableMapEmits<K, V>>

complete

Returns void

delete

Parameters

key: K

Returns boolean

get

Parameters

key: K

Returns undefined | V

has

Parameters

key: K

Returns boolean

Protected notify

Parameters

event: "set"

args: [key: K, value: V]

Optional result: undefined

Returns void

Parameters

event: "delete"

args: [key: K]

result: boolean

Returns void

Parameters

event: "get"

args: [key: K]

result: undefined | V

Returns void

Parameters

event: "has"

args: [key: K]

result: boolean

Returns void

set

Parameters

key: K

value: V

Returns ObservableMap<K, V>

Static filterEvents

Type Parameters

Type Parameters

E extends "delete" | "get" | "has" | "set"

K

V

Parameters

Rest ...eventNames: E[]

Returns OperatorFunction<ObservableMapEmits<K, V>, ObservableMapEmitsFiltered<K, V, E>>

`Optional` entries: null | readonly (readonly [K, V])[]

`Optional` iterable: null | Iterable<readonly [K, V]>

`Readonly` [toStringTag]

`Protected` notify

`Optional` result: undefined

`Static` filterEvents

`Rest` ...eventNames: E[]

`Static` ignoreEvents

`Rest` ...eventNames: E[]