Class EventEmittingMap<K, V>

Type Parameters

Hierarchy

Map<K, V>
Hierarchy
- EventEmittingMap

Index

Constructors

constructor

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

Properties

`Readonly` [toStringTag]

[toStringTag]: "EventEmittingMap" = 'EventEmittingMap'

`Protected` listeners

listeners: { delete: ((...args: any[]) => void)[]; get: ((...args: any[]) => void)[]; has: ((...args: any[]) => void)[]; set: ((...args: any[]) => void)[] } = ...

Type declaration

delete: ((...args: any[]) => void)[]
get: ((...args: any[]) => void)[]
has: ((...args: any[]) => void)[]
set: ((...args: any[]) => void)[]

Methods

addListener

addListener(event: "set", callback: ((key: K, value: V) => void), once?: boolean): EventEmittingMap<K, V>
Parameters
- event: "set"
- callback: ((key: K, value: V) => void)
  - - (key: K, value: V): void
    - Parameters
      
      key: K
      
      value: V
      
      Returns void
- Optional once: boolean
Returns EventEmittingMap<K, V>
- Defined in src/data-structures/maps/event-emitting.ts:93
addListener(event: "delete", callback: ((key: K, result: boolean) => void), once?: boolean): EventEmittingMap<K, V>
Parameters
- event: "delete"
- callback: ((key: K, result: boolean) => void)
  - - (key: K, result: boolean): void
    - Parameters
      
      key: K
      
      result: boolean
      
      Returns void
- Optional once: boolean
Returns EventEmittingMap<K, V>
- Defined in src/data-structures/maps/event-emitting.ts:98
addListener(event: "get", callback: ((key: K, result: undefined | V) => void), once?: boolean): EventEmittingMap<K, V>
Parameters
- event: "get"
- callback: ((key: K, result: undefined | V) => void)
  - - (key: K, result: undefined | V): void
    - Parameters
      
      key: K
      
      result: undefined | V
      
      Returns void
- Optional once: boolean
Returns EventEmittingMap<K, V>
- Defined in src/data-structures/maps/event-emitting.ts:103
addListener(event: "has", callback: ((key: K, result: boolean) => void), once?: boolean): EventEmittingMap<K, V>
Parameters
- event: "has"
- callback: ((key: K, result: boolean) => void)
  - - (key: K, result: boolean): void
    - Parameters
      
      key: K
      
      result: boolean
      
      Returns void
- Optional once: boolean
Returns EventEmittingMap<K, V>
- Defined in src/data-structures/maps/event-emitting.ts:108

eventNames

eventNames(): ("delete" | "get" | "has" | "set")[]
Returns an array listing the events for which the Map has registered listeners.

Returns ("delete" | "get" | "has" | "set")[]
- Defined in src/data-structures/maps/event-emitting.ts:66

listenerCount

listenerCount(event?: "delete" | "get" | "has" | "set"): number
Parameters
- Optional event: "delete" | "get" | "has" | "set"
Returns number
- Defined in src/data-structures/maps/event-emitting.ts:80

prependListener

prependListener(event: "set", callback: ((key: K, value: V) => void), once?: boolean): EventEmittingMap<K, V>
Parameters
- event: "set"
- callback: ((key: K, value: V) => void)
  - - (key: K, value: V): void
    - Parameters
      
      key: K
      
      value: V
      
      Returns void
- Optional once: boolean
Returns EventEmittingMap<K, V>
- Defined in src/data-structures/maps/event-emitting.ts:130
prependListener(event: "delete", callback: ((key: K, result: boolean) => void), once?: boolean): EventEmittingMap<K, V>
Parameters
- event: "delete"
- callback: ((key: K, result: boolean) => void)
  - - (key: K, result: boolean): void
    - Parameters
      
      key: K
      
      result: boolean
      
      Returns void
- Optional once: boolean
Returns EventEmittingMap<K, V>
- Defined in src/data-structures/maps/event-emitting.ts:135
prependListener(event: "get", callback: ((key: K, result: undefined | V) => void), once?: boolean): EventEmittingMap<K, V>
Parameters
- event: "get"
- callback: ((key: K, result: undefined | V) => void)
  - - (key: K, result: undefined | V): void
    - Parameters
      
      key: K
      
      result: undefined | V
      
      Returns void
- Optional once: boolean
Returns EventEmittingMap<K, V>
- Defined in src/data-structures/maps/event-emitting.ts:140
prependListener(event: "has", callback: ((key: K, result: boolean) => void), once?: boolean): EventEmittingMap<K, V>
Parameters
- event: "has"
- callback: ((key: K, result: boolean) => void)
  - - (key: K, result: boolean): void
    - Parameters
      
      key: K
      
      result: boolean
      
      Returns void
- Optional once: boolean
Returns EventEmittingMap<K, V>
- Defined in src/data-structures/maps/event-emitting.ts:145

removeAllListeners

removeAllListeners(event?: "delete" | "get" | "has" | "set"): boolean
Parameters
- Optional event: "delete" | "get" | "has" | "set"
Returns boolean
- Defined in src/data-structures/maps/event-emitting.ts:192

removeListener

removeListener(event: "set", callback: ((key: K, value: V) => void)): boolean
Parameters
- event: "set"
- callback: ((key: K, value: V) => void)
  - - (key: K, value: V): void
    - Parameters
      
      key: K
      
      value: V
      
      Returns void
Returns boolean
- Defined in src/data-structures/maps/event-emitting.ts:167
removeListener(event: "delete", callback: ((key: K, result: boolean) => void)): boolean
Parameters
- event: "delete"
- callback: ((key: K, result: boolean) => void)
  - - (key: K, result: boolean): void
    - Parameters
      
      key: K
      
      result: boolean
      
      Returns void
Returns boolean
- Defined in src/data-structures/maps/event-emitting.ts:168
removeListener(event: "has", callback: ((key: K, result: boolean) => void)): boolean
Parameters
- event: "has"
- callback: ((key: K, result: boolean) => void)
  - - (key: K, result: boolean): void
    - Parameters
      
      key: K
      
      result: boolean
      
      Returns void
Returns boolean
- Defined in src/data-structures/maps/event-emitting.ts:172
removeListener(event: "get", callback: ((key: K, result: undefined | V) => void)): boolean
Parameters
- event: "get"
- callback: ((key: K, result: undefined | V) => void)
  - - (key: K, result: undefined | V): void
    - Parameters
      
      key: K
      
      result: undefined | V
      
      Returns void
Returns boolean
- Defined in src/data-structures/maps/event-emitting.ts:176

Events

delete

delete(key: K): boolean
Parameters
- key: K
  
  'delete'
Returns boolean
Overrides Map.delete
- Defined in src/data-structures/maps/event-emitting.ts:41

get

get(key: K): undefined | V
Parameters
- key: K
  
  'get'
Returns undefined | V
Overrides Map.get
- Defined in src/data-structures/maps/event-emitting.ts:15

has

has(key: K): boolean
Parameters
- key: K
  
  'has'
Returns boolean
Overrides Map.has
- Defined in src/data-structures/maps/event-emitting.ts:28

set

set(key: K, value: V): EventEmittingMap<K, V>
Parameters
- key: K
- value: V
  
  'set' emits the 'set' event
Returns EventEmittingMap<K, V>
Overrides Map.set
- Defined in src/data-structures/maps/event-emitting.ts:55

Class EventEmittingMap<K, V>

Type Parameters

K

V

Hierarchy

Hierarchy

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Type Parameters

Type Parameters

K

V

Parameters

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

Returns EventEmittingMap<K, V>

Type Parameters

Type Parameters

K

V

Parameters

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

Returns EventEmittingMap<K, V>

Properties

Readonly [toStringTag]

Protected listeners

Type declaration

delete: ((...args: any[]) => void)[]

get: ((...args: any[]) => void)[]

has: ((...args: any[]) => void)[]

set: ((...args: any[]) => void)[]

Methods

addListener

Parameters

event: "set"

callback: ((key: K, value: V) => void)

Parameters

key: K

value: V

Returns void

Optional once: boolean

Returns EventEmittingMap<K, V>

Parameters

event: "delete"

callback: ((key: K, result: boolean) => void)

Parameters

key: K

result: boolean

Returns void

Optional once: boolean

Returns EventEmittingMap<K, V>

Parameters

event: "get"

callback: ((key: K, result: undefined | V) => void)

Parameters

key: K

result: undefined | V

Returns void

Optional once: boolean

Returns EventEmittingMap<K, V>

Parameters

event: "has"

callback: ((key: K, result: boolean) => void)

Parameters

key: K

result: boolean

Returns void

Optional once: boolean

Returns EventEmittingMap<K, V>

eventNames

Returns ("delete" | "get" | "has" | "set")[]

listenerCount

Parameters

Optional event: "delete" | "get" | "has" | "set"

Returns number

prependListener

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

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

`Readonly` [toStringTag]

`Protected` listeners

`Optional` once: boolean

`Optional` once: boolean

`Optional` once: boolean

`Optional` once: boolean

`Optional` event: "delete" | "get" | "has" | "set"

`Optional` once: boolean

`Optional` once: boolean

`Optional` once: boolean

`Optional` once: boolean

`Optional` event: "delete" | "get" | "has" | "set"