Class MapOfMutableImpl<V, M>`Internal`

Type Parameters

Hierarchy (View Summary)

SimpleEventEmitter<MapArrayEvents<V>>
- MapOfMutableImpl

Implements

IMapOfMutableExtended<V, M>

Index

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
- Defined in packages/collections/src/map/map-of-multi-impl.ts:240

isDisposed

get isDisposed(): boolean
Returns boolean
Implementation of IMapOfMutableExtended.isDisposed
Inherited from SimpleEventEmitter.isDisposed
- Defined in packages/events/src/simple-event-emitter.ts:13

isEmpty

get isEmpty(): boolean
Returns true if the map is empty

Returns boolean
Implementation of IMapOfMutableExtended.isEmpty
- Defined in packages/collections/src/map/map-of-multi-impl.ts:74

lengthKeys

get lengthKeys(): number
Returns the number of keys

Returns number
Implementation of IMapOfMutableExtended.lengthKeys
- Defined in packages/collections/src/map/map-of-multi-impl.ts:40

lengthMax

get lengthMax(): number
Returns the length of the longest child list

Returns number
- Defined in packages/collections/src/map/map-of-multi-impl.ts:47

size

get size(): number
Returns number
- Defined in packages/collections/src/map/map-of-multi-impl.ts:235

typeName

get typeName(): string
Returns the type name. For in-built implementations, it will be one of: array, set or circular

Returns string
Implementation of IMapOfMutableExtended.typeName
- Defined in packages/collections/src/map/map-of-multi-impl.ts:33

Constructors

constructor

new MapOfMutableImpl<V, M>(
type: MultiValue<V, M>,
opts?: MapMultiOpts<V>,
): MapOfMutableImpl<V, M>
Type Parameters
- V
- M
Parameters
- type: MultiValue<V, M>
- opts: MapMultiOpts<V> = {}
Returns MapOfMutableImpl<V, M>
Overrides SimpleEventEmitter.constructor
- Defined in packages/collections/src/map/map-of-multi-impl.ts:24

Methods

addEventListener

addEventListener<K extends keyof MapArrayEvents<V>>(
    name: K,
    listener: (
        event: MapArrayEvents<V>[K],
        sender: SimpleEventEmitter<MapArrayEvents<V>>,
    ) => void,
): void
Adds event listener.
Type Parameters
- K extends keyof MapArrayEvents<V>
  Events
Parameters
- name: K
  Event name
- listener: (
  event: MapArrayEvents<V>[K],
  sender: SimpleEventEmitter<MapArrayEvents<V>>,
  ) => void
  Event handler
Returns void
Throws
Error if emitter is disposed
Implementation of IMapOfMutableExtended.addEventListener
Inherited from SimpleEventEmitter.addEventListener
- Defined in packages/events/src/simple-event-emitter.ts:39

addKeyedValues

addKeyedValues(key: string, ...values: V[]): void
Adds several values under the same key. Duplicate values are permitted, depending on implementation.
Parameters
- key: string
- ...values: V[]
Returns void
Implementation of IMapOfMutableExtended.addKeyedValues
- Defined in packages/collections/src/map/map-of-multi-impl.ts:83

addValue

addValue(...values: readonly V[]): void
Adds a value, automatically extracting a key via the groupBy function assigned in the constructor options.
Parameters
- ...values: readonly V[]
  Adds several values
Returns void
Implementation of IMapOfMutableExtended.addValue
- Defined in packages/collections/src/map/map-of-multi-impl.ts:99

clear

clear(): void
Clears the map

Returns void
Implementation of IMapOfMutableExtended.clear
- Defined in packages/collections/src/map/map-of-multi-impl.ts:78

count

count(key: string): number
Returns the number of values stored under key, or 0 if key is not present.
Parameters
- key: string
  Key
Returns number
Implementation of IMapOfMutableExtended.count
- Defined in packages/collections/src/map/map-of-multi-impl.ts:164

debugString

debugString(): string
Returns a human-readable rendering of contents

Returns string
Implementation of IMapOfMutableExtended.debugString
- Defined in packages/collections/src/map/map-of-multi-impl.ts:55

delete

delete(key: string): boolean
Deletes all values stored under key. Returns true if key was found
Parameters
- key: string
Returns boolean
Implementation of IMapOfMutableExtended.delete
- Defined in packages/collections/src/map/map-of-multi-impl.ts:142

deleteByValue

deleteByValue(value: V): boolean
Delete all occurrences of value, regardless of key it is stored under. Returns true if something was deleted.
Parameters
- value: V
Returns boolean
Implementation of IMapOfMutableExtended.deleteByValue
- Defined in packages/collections/src/map/map-of-multi-impl.ts:127

deleteKeyValue

deleteKeyValue(key: string, value: V): boolean
Deletes all values under key that match value.
Parameters
- key: string
  Key
- value: V
  Value
Returns boolean
Implementation of IMapOfMutableExtended.deleteKeyValue
- Defined in packages/collections/src/map/map-of-multi-impl.ts:113

dispose

dispose(): void
Returns void
Implementation of IMapOfMutableExtended.dispose
Inherited from SimpleEventEmitter.dispose
- Defined in packages/events/src/simple-event-emitter.ts:8

entries

entries(): IterableIterator<[key: string, value: V[]]>
Returns IterableIterator<[key: string, value: V[]]>
Implementation of IMapOfMutableExtended.entries
- Defined in packages/collections/src/map/map-of-multi-impl.ts:215

entriesFlat

entriesFlat(): IterableIterator<[key: string, value: V]>
Iterates over key-value pairs. Unlike a normal map, the same key may appear several times.

Returns IterableIterator<[key: string, value: V]>
Implementation of IMapOfMutableExtended.entriesFlat
- Defined in packages/collections/src/map/map-of-multi-impl.ts:201

`Protected`fireEvent

fireEvent<K extends keyof MapArrayEvents<V>>(
type: K,
args: MapArrayEvents<V>[K],
): void
Fire event
Type Parameters
- K extends keyof MapArrayEvents<V>
Parameters
- type: K
  Type of event
- args: MapArrayEvents<V>[K]
  Arguments for event
Returns void
Implementation of IMapOfMutableExtended.fireEvent
Inherited from SimpleEventEmitter.fireEvent
- Defined in packages/events/src/simple-event-emitter.ts:23

firstKeyByValue

firstKeyByValue(value: V, eq?: IsEqual<V>): undefined | string
Finds the first key where value is stored. Note: value could be stored in multiple keys
Parameters
- value: V
  Value to seek
- eq: IsEqual<V> = isEqualDefault
Returns undefined | string
Key, or undefined if value not found
Implementation of IMapOfMutableExtended.firstKeyByValue
- Defined in packages/collections/src/map/map-of-multi-impl.ts:150

get

get(key: string): IterableIterator<V>
Iterates over values stored under key An empty array is returned if there are no values
Parameters
- key: string
Returns IterableIterator<V>
Implementation of IMapOfMutableExtended.get
- Defined in packages/collections/src/map/map-of-multi-impl.ts:174

has

has(key: string): boolean
Returns true if key has any values
Parameters
- key: string
Returns boolean
Implementation of IMapOfMutableExtended.has
- Defined in packages/collections/src/map/map-of-multi-impl.ts:109

hasKeyValue

hasKeyValue(key: string, value: V, eq: IsEqual<V>): boolean
Returns true if value is stored under key.
Parameters
- key: string
  Key
- value: V
  Value
- eq: IsEqual<V>
Returns boolean
Implementation of IMapOfMutableExtended.hasKeyValue
- Defined in packages/collections/src/map/map-of-multi-impl.ts:103

keys

keys(): IterableIterator<string>
Iterates over all keys

Returns IterableIterator<string>
Implementation of IMapOfMutableExtended.keys
- Defined in packages/collections/src/map/map-of-multi-impl.ts:196

keysAndCounts

keysAndCounts(): IterableIterator<[string, number]>
Iteates over all keys and the count of values therein

Returns IterableIterator<[string, number]>
Implementation of IMapOfMutableExtended.keysAndCounts
- Defined in packages/collections/src/map/map-of-multi-impl.ts:222

merge

merge(other: IMapOf<V>): void
Parameters
- other: IMapOf<V>
Returns void
- Defined in packages/collections/src/map/map-of-multi-impl.ts:228

removeEventListener

removeEventListener<K extends keyof MapArrayEvents<V>>(
    type: K,
    listener: (
        event: MapArrayEvents<V>[K],
        sender: SimpleEventEmitter<MapArrayEvents<V>>,
    ) => void,
): void
Remove event listener
Type Parameters
- K extends keyof MapArrayEvents<V>
Parameters
- type: K
- listener: (
  event: MapArrayEvents<V>[K],
  sender: SimpleEventEmitter<MapArrayEvents<V>>,
  ) => void
Returns void
Implementation of IMapOfMutableExtended.removeEventListener
Inherited from SimpleEventEmitter.removeEventListener
- Defined in packages/events/src/simple-event-emitter.ts:55

set

set(key: string, values: V[]): MapOfMutableImpl<V, M>
Parameters
- key: string
- values: V[]
Returns MapOfMutableImpl<V, M>
- Defined in packages/collections/src/map/map-of-multi-impl.ts:94

valuesFlat

valuesFlat(): IterableIterator<V>
Iterates over all values, regardless of key. Same value may re-appear if it's stored under different keys.

Returns IterableIterator<V>
Implementation of IMapOfMutableExtended.valuesFlat
- Defined in packages/collections/src/map/map-of-multi-impl.ts:209

valuesFor

valuesFor(key: string): Generator<V, void, any>
Iterate over the values stored under key. If key does not exist, iteration is essentially a no-op
Parameters
- key: string
Returns Generator<V, void, any>
- Defined in packages/collections/src/map/map-of-multi-impl.ts:186

Properties

`Readonly`groupBy

groupBy: ToString<V>

`Readonly`type

type: MultiValue<V, M>

Class MapOfMutableImpl<V, M>Internal

Type Parameters

Hierarchy (View Summary)

Implements

Index

Accessors

Constructors

Methods

Properties

Accessors

[toStringTag]

Returns string

isDisposed

Returns boolean

isEmpty

Returns boolean

lengthKeys

Returns number

lengthMax

Returns number

size

Returns number

typeName

Returns string

Constructors

constructor

Type Parameters

Parameters

Returns MapOfMutableImpl<V, M>

Methods

addEventListener

Type Parameters

Parameters

Returns void

Throws

addKeyedValues

Parameters

Returns void

addValue

Parameters

Returns void

clear

Returns void

count

Parameters

Returns number

debugString

Returns string

delete

Parameters

Returns boolean

deleteByValue

Parameters

Returns boolean

deleteKeyValue

Parameters

Returns boolean

dispose

Returns void

entries

Returns IterableIterator<[key: string, value: V[]]>

entriesFlat

Returns IterableIterator<[key: string, value: V]>

ProtectedfireEvent

Type Parameters

Parameters

Returns void

firstKeyByValue

Parameters

Returns undefined | string

get

Parameters

Returns IterableIterator<V>

has

Parameters

Returns boolean

hasKeyValue

Parameters

Returns boolean

keys

Class MapOfMutableImpl<V, M>`Internal`

`Protected`fireEvent

`Readonly`groupBy

`Readonly`type