Class Group<K, V>

Readonly [toStringTag]

Readonly size

Static Readonly [species]

maxSize

• get maxSize(): number

• Returns number

• set maxSize(value): void

• Parameters

  • value: number

  Returns void

K

• K(): K[]

• Returns K[]

V

• V(): V[]

• Returns V[]

[iterator]

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

• Returns an iterable of entries in the map.

  Returns IterableIterator<[K, V]>

add

• add(value): Group<K, V>

• Parameters

  • value: V

  Returns Group<K, V>

bottom

• bottom(amount?): undefined | V | V[]

• Parameters

  • Optional amount: number

  Returns undefined | V | V[]

break

• break(func): default<K, V>[]

• Parameters

  • func: ((val, key, grp) => boolean)

    • • (val, key, grp): boolean

      • Parameters

        • val: V

        • key: K

        • grp: Group<K, V>

        Returns boolean

  Returns default<K, V>[]

clear

• clear(): void

• Returns void

clone

• clone(): default<K, V>

• Returns default<K, V>

delete

• delete(key): boolean

• Parameters

  • key: K

  Returns boolean

  true if an element in the Map existed and has been removed, or false if the element does not exist.

diff

• diff(other): default<K, V>

• Parameters

  • other: default<K, V>

  Returns default<K, V>

entries

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

• Returns an iterable of key, value pairs for every entry in the map.

  Returns IterableIterator<[K, V]>

every

• every(func): undefined | false

• Parameters

  • func: ((val, key, grp) => boolean)

    • • (val, key, grp): boolean

      • Parameters

        • val: V

        • key: K

        • grp: Group<K, V>

        Returns boolean

  Returns undefined | false

findEntry

• findEntry(func): undefined | (K | V)[]

• Parameters

  • func: ((val, key, grp) => boolean)

    • • (val, key, grp): boolean

      • Parameters

        • val: V

        • key: K

        • grp: Group<K, V>

        Returns boolean

  Returns undefined | (K | V)[]

findIndex

• findIndex(func): undefined | number

• Parameters

  • func: ((val, key, grp) => boolean)

    • • (val, key, grp): boolean

      • Parameters

        • val: V

        • key: K

        • grp: Group<K, V>

        Returns boolean

  Returns undefined | number

findKey

• findKey(func): undefined | K

• Parameters

  • func: ((val, key, grp) => boolean)

    • • (val, key, grp): boolean

      • Parameters

        • val: V

        • key: K

        • grp: Group<K, V>

        Returns boolean

  Returns undefined | K

forEach

• forEach(callbackfn, thisArg?): void

• Executes a provided function once per each key/value pair in the Map, in insertion order.

  Parameters

  • callbackfn: ((value, key, map) => void)

    • • (value, key, map): void

      • Parameters

        • value: V

        • key: K

        • map: Map<K, V>

        Returns void

  • Optional thisArg: any

  Returns void

has

• has(key): boolean

• Parameters

  • key: K

  Returns boolean

  boolean indicating whether an element with the specified key exists or not.

intersect

• intersect(other): default<K, V>

• Parameters

  • other: default<K, V>

  Returns default<K, V>

keys

• keys(): IterableIterator<K>

• Returns an iterable of keys in the map

  Returns IterableIterator<K>

map

• map<T>(func): default<K, T>

• Type Parameters

  • T

  Parameters

  • func: ((val, key, grp) => T)

    • • (val, key, grp): T

      • Parameters

        • val: V

        • key: K

        • grp: Group<K, V>

        Returns T

  Returns default<K, T>

pop

• pop(): undefined | V

• Returns undefined | V

popN

• popN(amount): undefined | V | V[]

• Parameters

  • amount: number

  Returns undefined | V | V[]

reduce

• reduce(func, init?): undefined | V

• Parameters

  • func: ((acc, val, key, grp) => V)

    • • (acc, val, key, grp): V

      • Parameters

        • acc: V

        • val: V

        • key: K

        • grp: Group<K, V>

        Returns V

  • Optional init: V

  Returns undefined | V

set

• set(key, value): Group<K, V>

• Parameters

  • key: K

  • value: V

  Returns Group<K, V>

shift

• shift(): undefined | V

• Returns undefined | V

shiftN

• shiftN(amount): undefined | V | V[]

• Parameters

  • amount: number

  Returns undefined | V | V[]

some

• some(func): undefined | true

• Parameters

  • func: ((val, key, grp) => boolean)

    • • (val, key, grp): boolean

      • Parameters

        • val: V

        • key: K

        • grp: Group<K, V>

        Returns boolean

  Returns undefined | true

sort

• sort(func): default<K, V>

• Parameters

  • func: ((a, b) => number)

    • • (a, b): number

      • Parameters

        • a: V

        • b: V

        Returns number

  Returns default<K, V>

sortKeys

• sortKeys(func): default<K, V>

• Parameters

  • func: ((a, b) => number)

    • • (a, b): number

      • Parameters

        • a: K

        • b: K

        Returns number

  Returns default<K, V>

toJSON

• toJSON(): Record<string, V>

• Returns Record<string, V>

top

• top(amount?): undefined | V | V[]

• Parameters

  • Optional amount: number

  Returns undefined | V | V[]

union

• union(other): default<K, V>

• Parameters

  • other: default<K, V>

  Returns default<K, V>

values

• values(): IterableIterator<V>

• Returns an iterable of values in the map

  Returns IterableIterator<V>

weakSort

• weakSort(): default<K, V>

• Returns default<K, V>