Class ReadonlyMultiKeyMap<K, V>

Map with entries that contains multiple keys and a single value

Author

David Hsing

Type Parameters

  • K
  • V

Implements

  • Omit<ReadonlyMap<K[], V>,
        | "forEach"
        | "get"
        | "has"
        | "entries"
        | "keys"
        | "values">

Constructors

constructor

Accessors

[toStringTag] size

Methods

[iterator] entries forEach forEachBreakable forEachIndexing get hasAllKeys hasAllValues hasAnyKeys hasAnyValues hasKey hasKeyValue hasValue isEmpty isNotEmpty keys toString values of

Constructors

constructor

  • new ReadonlyMultiKeyMap<K, V>(entries?): ReadonlyMultiKeyMap<K, V>

  • Construct a readonly multi key map instance

    Type Parameters

    • K
    • V

    Parameters

    Returns ReadonlyMultiKeyMap<K, V>

    Example

    const map = new ReadonlyMultiKeyMap([
        [['row1', 'col1'], 'foo']
    ]);

Accessors

[toStringTag]

  • get [toStringTag](): string

  • Returns the string representation of the map identifier ('ReadonlyMultiKeyMap')

    Returns string

    the string representation of the map identifier

size

  • get size(): number

  • Returns the size of map

    Returns number

    the size of map

Methods

[iterator]

  • [iterator](): IterableIterator<[K[], V], any, any>

  • Response for returning the list of keys/value to iterate

    Returns IterableIterator<[K[], V], any, any>

    Example

    for (const [keys, value] of map) {
        console.log(value);
    }

entries

  • entries(): [K[], V][]

  • Returns the keys/value entries of the map

    Returns [K[], V][]

    the keys/value entries of the map

forEach

  • forEach(callback, thisArg?): void

  • Processes each entry in the map

    Parameters

    • callback: ((value: V, keys: K[]) => void)

      a callback function that processes each entry

        • (value, keys): void

        • Parameters

          • value: V
          • keys: K[]

          Returns void

    • OptionalthisArg: any

      any instance to retrieve 'this' reference in the callback function

    Returns void

    Example

    map.forEach((value, keys) => {
        console.log(value);
    });

forEachBreakable

  • forEachBreakable(callback, thisArg?): void

  • Processes each entry in the map with breakable capability

    Parameters

    • callback: ((value: V, keys: K[]) => boolean)

      a callback function that processes each entry. Returning false indicates to break the map iteration

        • (value, keys): boolean

        • Parameters

          • value: V
          • keys: K[]

          Returns boolean

    • OptionalthisArg: any

      any instance to retrieve 'this' reference in the callback function

    Returns void

    Example

    map.forEachBreakable((value, keys) => {
        return true;
    });

forEachIndexing

  • forEachIndexing(callback, thisArg?): void

  • Processes each entry in the map with index capability

    Parameters

    • callback: ((value: V, keys: K[], index: number) => void)

      a callback function that processes each entry

        • (value, keys, index): void

        • Parameters

          • value: V
          • keys: K[]
          • index: number

          Returns void

    • OptionalthisArg: any

      any instance to retrieve 'this' reference in the callback function

    Returns void

    Example

    map.forEachIndexing((value, keys, index) => {
        console.log(index);
    });

get

  • get(keys, defaults?): undefined | V

  • Returns the value of the given keys

    Parameters

    • keys: K[]

      the keys to retrieve

    • Optionaldefaults: V

      the default value if not found

    Returns undefined | V

    the value of the given keys

    Example

    const map = ReadonlyMultiKeyMap.of([
        [['row1', 'col1'], 'foo']
    ]);
    map.get(['row1', 'col1']);    // 'foo'
    map.get(['row2', 'col2'], 'bar');    // 'bar'

hasAllKeys

  • hasAllKeys(keys, exact?): boolean

  • Returns whether the map contains all the given keys

    Parameters

    • keys: K[][]

      the keys to check

    • exact: boolean = true

      whether matching entry values exactly

    Returns boolean

    whether the map contains all the given keys

    Example

    const map = ReadonlyMultiKeyMap.of([
        [['row1', 'col1'], 'foo']
    ]);
    map.hasAllKeys([['row1', 'col1'], ['row2', 'col2']]);    // false

hasAllValues

  • hasAllValues(values): boolean

  • Returns whether the map contains all the given values

    Parameters

    • values: V[]

      the values to check

    Returns boolean

    whether the map contains all the given values

    Example

    map.hasAllValues(['foo', 'bar']);

hasAnyKeys

  • hasAnyKeys(keys, exact?): boolean

  • Returns whether the map contains any of the given keys

    Parameters

    • keys: K[][]

      the keys to check

    • exact: boolean = true

      whether matching entry values exactly

    Returns boolean

    whether the map contains any of the given keys

    Example

    const map = ReadonlyMultiKeyMap.of([
        [['row1', 'col1'], 'foo']
    ]);
    map.hasAnyKeys([['row1', 'col1'], ['row2', 'col2']]);    // true

hasAnyValues

  • hasAnyValues(values): boolean

  • Returns whether the map contains any of the given values

    Parameters

    • values: V[]

      the values to check

    Returns boolean

    whether the map contains any of the given values

    Example

    const map = ReadonlyMultiKeyMap.of([
        [['row1', 'col1'], 'foo']
    ]);
    map.hasAnyValues(['foo', 'bar']);    // true

hasKey

  • hasKey(keys, exact?): boolean

  • Returns whether the map contains the given keys

    Parameters

    • keys: K[]

      the keys to check

    • exact: boolean = true

      whether matching entry values exactly

    Returns boolean

    whether the map contains the given key

    Example

    map.hasKey(['row1', 'col1']);

hasKeyValue

  • hasKeyValue(keys, value): boolean

  • Returns whether the map contains the given keys/value pair

    Parameters

    • keys: K[]

      the keys to check

    • value: V

      the value to check

    Returns boolean

    whether the map contains the given keys/value pair

    Example

    const map = ReadonlyMultiKeyMap.of([
        [['row1', 'col1'], 'foo']
    ]);
    map.hasKeyValue(['row1', 'col1'], 'foo');    // true
    map.hasKeyValue(['row1', 'col1'], 'bar');    // false

hasValue

  • hasValue(value): boolean

  • Returns whether the map contains the given value

    Parameters

    • value: V

      the value to check

    Returns boolean

    whether the map contains the given value

    Example

    const map = ReadonlyMultiKeyMap.of([
        [['row1', 'col1'], 'foo']
    ]);
    map.hasValue('foo');    // true
    map.hasValue('bar');    // false

isEmpty

  • isEmpty(): boolean

  • Returns whether the map is empty

    Returns boolean

    whether the map is empty

isNotEmpty

  • isNotEmpty(): boolean

  • Returns whether the map is not empty

    Returns boolean

    whether the map is not empty

keys

  • keys(): K[][]

  • Returns the keys array of the map

    Returns K[][]

    the keys array of the map

toString

  • toString(): string

  • Returns the string representation of the map elements

    Returns string

    the string representation of the map elements

    Example

    const map = ReadonlyMultiKeyMap.of([
        [['row1', 'col1'], 'foo'],
        [['row2', 'col2'], 'bar']
    ]);
    console.log(map.toString());    // '[row1,col1]:foo;[row2,col2]:bar'

values

  • values(): V[]

  • Returns the values of the map

    Returns V[]

    the values of the map

Staticof

  • of<K, V>(entries?): ReadonlyMultiKeyMap<K, V>

  • Construct a readonly multi key map instance

    Type Parameters

    • K
    • V

    Parameters

    Returns ReadonlyMultiKeyMap<K, V>

    a readonly multi key map instance

    Example

    const map = ReadonlyMultiKeyMap.of([
        [['row1', 'col1'], 'foo']
    ]);

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods