Interface IMapOfMutable<V>

interface IMapOfMutable<V> {
    get isEmpty(): boolean;
    get lengthKeys(): number;
    addKeyedValues(key: string, ...values: readonly V[]): void;
    addValue(...values: readonly V[]): void;
    clear(): void;
    count(key: string): number;
    delete(key: string): boolean;
    deleteByValue(value: V): boolean;
    deleteKeyValue(key: string, value: V): boolean;
    entries(): IterableIterator<[key: string, value: V[]]>;
    entriesFlat(): IterableIterator<readonly [string, V]>;
    firstKeyByValue(value: V, eq?: IsEqual<V>): undefined | string;
    get(key: string): IterableIterator<V>;
    has(key: string): boolean;
    hasKeyValue(key: string, value: V, eq?: IsEqual<V>): boolean;
    keys(): IterableIterator<string>;
    keysAndCounts(): IterableIterator<readonly [string, number]>;
    valuesFlat(): IterableIterator<V>;
}

Type Parameters

Hierarchy (View Summary)

IMapOf<V>
- IMapOfMutable
  - IMapOfMutableExtended

Implemented by

Maps.MapOfSimpleMutable

Index

Accessors

isEmpty lengthKeys

Methods

addKeyedValues addValue clear count delete deleteByValue deleteKeyValue entries entriesFlat firstKeyByValue get has hasKeyValue keys keysAndCounts valuesFlat

Accessors

isEmpty

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

Returns boolean
Inherited from IMapOf.isEmpty
- Defined in packages/collections/src/map/imap-of.ts:51

lengthKeys

get lengthKeys(): number
Returns the number of keys

Returns number
- Defined in packages/collections/src/map/imap-of-mutable.ts:27

Methods

addKeyedValues

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

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
- Defined in packages/collections/src/map/imap-of-mutable.ts:17

clear

clear(): void
Clears the map

Returns void
- Defined in packages/collections/src/map/imap-of-mutable.ts:22

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
Inherited from IMapOf.count
- Defined in packages/collections/src/map/imap-of.ts:56

delete

delete(key: string): boolean
Deletes all values stored under key. Returns true if key was found
Parameters
- key: string
Returns boolean
- Defined in packages/collections/src/map/imap-of-mutable.ts:48

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
- Defined in packages/collections/src/map/imap-of-mutable.ts:42

deleteKeyValue

deleteKeyValue(key: string, value: V): boolean
Deletes all values under key that match value.
Parameters
- key: string
  Key
- value: V
  Value
Returns boolean
- Defined in packages/collections/src/map/imap-of-mutable.ts:34

entries

entries(): IterableIterator<[key: string, value: V[]]>
Returns IterableIterator<[key: string, value: V[]]>
Inherited from IMapOf.entries
- Defined in packages/collections/src/map/imap-of.ts:28

entriesFlat

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

Returns IterableIterator<readonly [string, V]>
Inherited from IMapOf.entriesFlat
- Defined in packages/collections/src/map/imap-of.ts:26

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
- Optionaleq: IsEqual<V>
Returns undefined | string
Key, or undefined if value not found
Inherited from IMapOf.firstKeyByValue
- Defined in packages/collections/src/map/imap-of.ts:64

get

get(key: string): IterableIterator<V>
Iterates over all values stored under key
Parameters
- key: string
Returns IterableIterator<V>
Inherited from IMapOf.get
- Defined in packages/collections/src/map/imap-of.ts:14

has

has(key: string): boolean
Returns true if key has any values
Parameters
- key: string
Returns boolean
Inherited from IMapOf.has
- Defined in packages/collections/src/map/imap-of.ts:46

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
- Optionaleq: IsEqual<V>
Returns boolean
Inherited from IMapOf.hasKeyValue
- Defined in packages/collections/src/map/imap-of.ts:40

keys

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

Returns IterableIterator<string>
Inherited from IMapOf.keys
- Defined in packages/collections/src/map/imap-of.ts:8

keysAndCounts

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

Returns IterableIterator<readonly [string, number]>
Inherited from IMapOf.keysAndCounts
- Defined in packages/collections/src/map/imap-of.ts:32

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>
Inherited from IMapOf.valuesFlat
- Defined in packages/collections/src/map/imap-of.ts:20

Interface IMapOfMutable<V>

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Accessors

Methods

Accessors

isEmpty

Returns boolean

lengthKeys

Returns number

Methods

addKeyedValues

Parameters

Returns void

addValue

Parameters

Returns void

clear

Returns void

count

Parameters

Returns number

delete

Parameters

Returns boolean

deleteByValue

Parameters

Returns boolean

deleteKeyValue

Parameters

Returns boolean

entries

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

entriesFlat

Returns IterableIterator<readonly [string, V]>

firstKeyByValue

Parameters

Returns undefined | string

get

Parameters

Returns IterableIterator<V>

has

Parameters

Returns boolean

hasKeyValue

Parameters

Returns boolean

keys

Returns IterableIterator<string>

keysAndCounts

Returns IterableIterator<readonly [string, number]>

valuesFlat

Returns IterableIterator<V>

Settings

On This Page