Class TypedCollection<M, C, E>

This is an internal class, you should not use it in your projects. If you want a collection type for your own projects, look at Collection.

Type Parameters

  • M extends Record<string, any>
  • C extends Base
  • E extends unknown[] = []

Hierarchy (view full)

Constructors

constructor

Properties

[toStringTag] extraOptions limit size [species]

Accessors

empty

Methods

[iterator] clear delete entries every filter find findIndex first forEach get has keys last map random reduce reduceRight set some toArray values

Constructors

constructor

Properties

Readonly [toStringTag]

[toStringTag]: string

extraOptions

extraOptions: Required<ExtraOptions<M, C, E>>

limit

limit: number

Readonly size

size: number

Returns

the number of elements in the Map.

Static Readonly [species]

[species]: MapConstructor

Accessors

empty

  • get empty(): boolean

  • If this collection is empty.

    Returns boolean

Methods

[iterator]

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

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[string, C]>

clear

delete

entries

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

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

    Returns IterableIterator<[string, C]>

every

filter

find

findIndex

first

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

          Returns void

    • Optional thisArg: any

    Returns void

get

  • get(key): undefined | C

  • 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 | C

    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>

last

map

  • map<T>(predicate, thisArg?): T[]

  • See: Array#map

    Type Parameters

    • T

    Parameters

    • predicate: ((value, index, obj) => T)
        • (value, index, obj): T

        • Parameters

          • value: C
          • index: number
          • obj: C[]

          Returns T

    • Optional thisArg: unknown

    Returns T[]

random

reduce

  • reduce(predicate): C

  • See: Array#reduce

    Parameters

    • predicate: ((previousValue, currentValue, currentIndex, array) => C)
        • (previousValue, currentValue, currentIndex, array): C

        • Parameters

          • previousValue: C
          • currentValue: C
          • currentIndex: number
          • array: C[]

          Returns C

    Returns C

  • reduce(predicate, initialValue): C

  • Parameters

    • predicate: ((previousValue, currentValue, currentIndex, array) => C)
        • (previousValue, currentValue, currentIndex, array): C

        • Parameters

          • previousValue: C
          • currentValue: C
          • currentIndex: number
          • array: C[]

          Returns C

    • initialValue: C

    Returns C

  • reduce<T>(predicate, initialValue): T

  • Type Parameters

    • T

    Parameters

    • predicate: ((previousValue, currentValue, currentIndex, array) => T)
        • (previousValue, currentValue, currentIndex, array): T

        • Parameters

          • previousValue: T
          • currentValue: C
          • currentIndex: number
          • array: C[]

          Returns T

    • initialValue: T

    Returns T

reduceRight

  • reduceRight(predicate): C

  • See: Array#reduceRight

    Parameters

    • predicate: ((previousValue, currentValue, currentIndex, array) => C)
        • (previousValue, currentValue, currentIndex, array): C

        • Parameters

          • previousValue: C
          • currentValue: C
          • currentIndex: number
          • array: C[]

          Returns C

    Returns C

  • reduceRight(predicate, initialValue): C

  • Parameters

    • predicate: ((previousValue, currentValue, currentIndex, array) => C)
        • (previousValue, currentValue, currentIndex, array): C

        • Parameters

          • previousValue: C
          • currentValue: C
          • currentIndex: number
          • array: C[]

          Returns C

    • initialValue: C

    Returns C

  • reduceRight<T>(predicate, initialValue): T

  • Type Parameters

    • T

    Parameters

    • predicate: ((previousValue, currentValue, currentIndex, array) => T)
        • (previousValue, currentValue, currentIndex, array): T

        • Parameters

          • previousValue: T
          • currentValue: C
          • currentIndex: number
          • array: C[]

          Returns T

    • initialValue: T

    Returns T

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: C

    Returns this

some

toArray

values

  • values(): IterableIterator<C>

  • Returns an iterable of values in the map

    Returns IterableIterator<C>

Settings

Member Visibility

Theme

On This Page

constructor[toStringTag]extraOptionslimitsize[species]empty[iterator]cleardeleteentrieseveryfilterfindfindIndexfirstforEachgethaskeyslastmaprandomreducereduceRightsetsometoArrayvalues