Class IndexInternal

constructor

• new Index(entries?): Index

• Parameters

  • Optional entries: null | readonly (readonly [string, Stats])[]

  Returns Index

• new Index(iterable?): Index

• Parameters

  • Optional iterable: null | Iterable<readonly [string, Stats]>

  Returns Index

Readonly [toStringTag]

Readonly size

Static Readonly [species]

[iterator]

• [iterator](): IterableIterator<[string, Stats]>

• Returns an iterable of entries in the map.

  Returns IterableIterator<[string, Stats]>

clear

• clear(): void

• Returns void

delete

• delete(key): boolean

• Parameters

  • key: string

  Returns boolean

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

entries

• entries(): IterableIterator<[string, Stats]>

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

  Returns IterableIterator<[string, Stats]>

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: Stats
        • key: string
        • map: Map<string, Stats>

        Returns void

  • Optional thisArg: any

  Returns void

get

• get(key): undefined | Stats

• Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

  Parameters

  • key: string

  Returns undefined | Stats

  Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

has

• has(key): boolean

• Parameters

  • key: string

  Returns boolean

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

keys

• keys(): IterableIterator<string>

• Returns an iterable of keys in the map

  Returns IterableIterator<string>

set

• set(key, value): this

• Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

  Parameters

  • key: string
  • value: Stats

  Returns this

values

• values(): IterableIterator<Stats>

• Returns an iterable of values in the map

  Returns IterableIterator<Stats>

Static groupBy

• groupBy<K, T>(items, keySelector): Map<K, T[]>

• Groups members of an iterable according to the return value of the passed callback.

  Type Parameters

  • K
  • T

  Parameters

  • items: Iterable<T>

    An iterable.
  • keySelector: ((item, index) => K)

    A callback which will be invoked for each item in items.

    • • (item, index): K

      • Parameters

        • item: T
        • index: number

        Returns K

  Returns Map<K, T[]>