Class Collection<K, V>

A Map with some Array-like additions.

Type Parameters

Hierarchy

Map<K, V>
- Collection

Index

Constructors

constructor

new Collection<K, V>(
entries?: readonly (readonly [K, V])[] | null,
): Collection<K, V>
Type Parameters
- K
- V
Parameters
- Optionalentries: readonly (readonly [K, V])[] | null
Returns Collection<K, V>
Inherited from Map<K, V>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:50
new Collection<K, V>(
iterable?: Iterable<readonly [K, V], any, any> | null,
): Collection<K, V>
Type Parameters
- K
- V
Parameters
- Optionaliterable: Iterable<readonly [K, V], any, any> | null
Returns Collection<K, V>
Inherited from Map<K, V>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:49
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:50

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`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
- Defined in lib/utils/Collection.ts:6

Methods

[iterator]

"[iterator]"(): MapIterator<[K, V]>
Returns an iterable of entries in the map.

Returns MapIterator<[K, V]>
Inherited from Map.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:143

clear

clear(): void
Returns void
Inherited from Map.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:20

delete

delete(key: K): 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.
Inherited from Map.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24

entries

entries(): MapIterator<[K, V]>
Returns an iterable of key, value pairs for every entry in the map.

Returns MapIterator<[K, V]>
Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:148

every

every<T, ThisArg = Collection<K, V>>(
predicate: (value: V, index: number, array: V[]) => value is T,
thisArg?: ThisArg,
): this is T[]
See: Array#every
Type Parameters
- T
- ThisArg = Collection<K, V>
Parameters
- predicate: (value: V, index: number, array: V[]) => value is T
- OptionalthisArg: ThisArg
Returns this is T[]
- Defined in lib/utils/Collection.ts:11
every<ThisArg = Collection<K, V>>(
predicate: (value: V, index: number, array: V[]) => unknown,
thisArg?: ThisArg,
): boolean
See: Array#every
Type Parameters
- ThisArg = Collection<K, V>
Parameters
- predicate: (value: V, index: number, array: V[]) => unknown
- OptionalthisArg: ThisArg
Returns boolean
- Defined in lib/utils/Collection.ts:15

filter

filter<S, ThisArg = Collection<K, V>>(
    predicate: (
        this: ThisArg,
        value: V,
        index: number,
        array: V[],
    ) => value is S,
    thisArg?: ThisArg,
): S[]
See: Array#filter
Type Parameters
- S
- ThisArg = Collection<K, V>
Parameters
- predicate: (this: ThisArg, value: V, index: number, array: V[]) => value is S
- OptionalthisArg: ThisArg
Returns S[]
- Defined in lib/utils/Collection.ts:24
filter<ThisArg = Collection<K, V>>(
    predicate: (
        this: ThisArg,
        value: V,
        index: number,
        array: V[],
    ) => unknown,
    thisArg?: ThisArg,
): V[]
See: Array#filter
Type Parameters
- ThisArg = Collection<K, V>
Parameters
- predicate: (this: ThisArg, value: V, index: number, array: V[]) => unknown
- OptionalthisArg: ThisArg
Returns V[]
- Defined in lib/utils/Collection.ts:28

find

find<S, ThisArg = Collection<K, V>>(
    predicate: (
        this: ThisArg,
        value: V,
        index: number,
        obj: V[],
    ) => value is S,
    thisArg?: ThisArg,
): S | undefined
See: Array#find
Type Parameters
- S
- ThisArg = Collection<K, V>
Parameters
- predicate: (this: ThisArg, value: V, index: number, obj: V[]) => value is S
- OptionalthisArg: ThisArg
Returns S | undefined
- Defined in lib/utils/Collection.ts:37
find<ThisArg = Collection<K, V>>(
predicate: (this: ThisArg, value: V, index: number, obj: V[]) => unknown,
thisArg?: ThisArg,
): V | undefined
See: Array#find
Type Parameters
- ThisArg = Collection<K, V>
Parameters
- predicate: (this: ThisArg, value: V, index: number, obj: V[]) => unknown
- OptionalthisArg: ThisArg
Returns V | undefined
- Defined in lib/utils/Collection.ts:41

findIndex

findIndex(
predicate: (value: V, index: number, obj: V[]) => unknown,
thisArg?: unknown,
): number
See: Array#findIndex
Parameters
- predicate: (value: V, index: number, obj: V[]) => unknown
- OptionalthisArg: unknown
Returns number
- Defined in lib/utils/Collection.ts:50

first

first(): V | undefined
Get the first element, or first X elements if a number is provided.

Returns V | undefined
- Defined in lib/utils/Collection.ts:58
first(amount: number): V[]
Get the first element, or first X elements if a number is provided.
Parameters
- amount: number
  The amount of elements to get.
Returns V[]
- Defined in lib/utils/Collection.ts:59

forEach

forEach(
callbackfn: (value: V, key: K, map: Map<K, V>) => void,
thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: V, key: K, map: Map<K, V>) => void
- OptionalthisArg: any
Returns void
Inherited from Map.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

get(key: K): V | undefined
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: K
Returns V | undefined
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Inherited from Map.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:33

has

has(key: K): boolean
Parameters
- key: K
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from Map.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:37

keys

keys(): MapIterator<K>
Returns an iterable of keys in the map

Returns MapIterator<K>
Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:153

last

last(): V | undefined
Get the last element, or last X elements if a number is provided.

Returns V | undefined
- Defined in lib/utils/Collection.ts:79
last(amount: number): V[]
Get the last element, or last X elements if a number is provided.
Parameters
- amount: number
  The amount of elements to get.
Returns V[]
- Defined in lib/utils/Collection.ts:80

map

map<T>(
predicate: (value: V, index: number, obj: V[]) => T,
thisArg?: unknown,
): T[]
See: Array#map
Type Parameters
- T
Parameters
- predicate: (value: V, index: number, obj: V[]) => T
- OptionalthisArg: unknown
Returns T[]
- Defined in lib/utils/Collection.ts:97

random

random(): V | undefined
Pick a random element from the collection, or undefined if the collection is empty.

Returns V | undefined
- Defined in lib/utils/Collection.ts:104

reduce

reduce(
    predicate: (
        previousValue: V,
        currentValue: V,
        currentIndex: number,
        array: V[],
    ) => V,
): V
See: Array#reduce
Parameters
- predicate: (previousValue: V, currentValue: V, currentIndex: number, array: V[]) => V
Returns V
- Defined in lib/utils/Collection.ts:114
reduce(
    predicate: (
        previousValue: V,
        currentValue: V,
        currentIndex: number,
        array: V[],
    ) => V,
    initialValue: V,
): V
See: Array#reduce
Parameters
- predicate: (previousValue: V, currentValue: V, currentIndex: number, array: V[]) => V
- initialValue: V
Returns V
- Defined in lib/utils/Collection.ts:115
reduce<T>(
    predicate: (
        previousValue: T,
        currentValue: V,
        currentIndex: number,
        array: V[],
    ) => T,
    initialValue: T,
): T
See: Array#reduce
Type Parameters
- T
Parameters
- predicate: (previousValue: T, currentValue: V, currentIndex: number, array: V[]) => T
- initialValue: T
Returns T
- Defined in lib/utils/Collection.ts:119

reduceRight

reduceRight(
    predicate: (
        previousValue: V,
        currentValue: V,
        currentIndex: number,
        array: V[],
    ) => V,
): V
See: Array#reduceRight
Parameters
- predicate: (previousValue: V, currentValue: V, currentIndex: number, array: V[]) => V
Returns V
- Defined in lib/utils/Collection.ts:131
reduceRight(
    predicate: (
        previousValue: V,
        currentValue: V,
        currentIndex: number,
        array: V[],
    ) => V,
    initialValue: V,
): V
See: Array#reduceRight
Parameters
- predicate: (previousValue: V, currentValue: V, currentIndex: number, array: V[]) => V
- initialValue: V
Returns V
- Defined in lib/utils/Collection.ts:132
reduceRight<T>(
    predicate: (
        previousValue: T,
        currentValue: V,
        currentIndex: number,
        array: V[],
    ) => T,
    initialValue: T,
): T
See: Array#reduceRight
Type Parameters
- T
Parameters
- predicate: (previousValue: T, currentValue: V, currentIndex: number, array: V[]) => T
- initialValue: T
Returns T
- Defined in lib/utils/Collection.ts:136

set

set(key: K, value: V): 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: K
- value: V
Returns this
Inherited from Map.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:41

some

some<ThisArg = Collection<K, V>>(
predicate: (value: V, index: number, array: V[]) => unknown,
thisArg?: ThisArg,
): boolean
See: Array#some
Type Parameters
- ThisArg = Collection<K, V>
Parameters
- predicate: (value: V, index: number, array: V[]) => unknown
- OptionalthisArg: ThisArg
Returns boolean
- Defined in lib/utils/Collection.ts:148

toArray

toArray(): V[]
Get the values of this collection as an array.

Returns V[]
- Defined in lib/utils/Collection.ts:156

values

values(): MapIterator<V>
Returns an iterable of values in the map

Returns MapIterator<V>
Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:158

`Static`groupBy

groupBy<K, T>(
items: Iterable<T>,
keySelector: (item: T, index: number) => K,
): 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: T, index: number) => K
  A callback which will be invoked for each item in items.
Returns Map<K, T[]>
Inherited from Map.groupBy
- Defined in node_modules/typescript/lib/lib.esnext.collection.d.ts:25

Class Collection<K, V>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Collection<K, V>

Type Parameters

Parameters

Returns Collection<K, V>

Properties

Readonly[toStringTag]

Readonlysize

Returns

Static Readonly[species]

Accessors

empty

Returns boolean

Methods

[iterator]

Returns MapIterator<[K, V]>

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns MapIterator<[K, V]>

every

Type Parameters

Parameters

Returns this is T[]

Type Parameters

Parameters

Returns boolean

filter

Type Parameters

Parameters

Returns S[]

Type Parameters

Parameters

Returns V[]

find

Type Parameters

Parameters

Returns S | undefined

Type Parameters

Parameters

Returns V | undefined

findIndex

Parameters

Returns number

first

Returns V | undefined

Parameters

Returns V[]

forEach

Parameters

Returns void

get

Parameters

Returns V | undefined

has

Parameters

Returns boolean

keys

Returns MapIterator<K>

last

Returns V | undefined

Parameters

Returns V[]

map

Type Parameters

Parameters

`Readonly`[toStringTag]

`Readonly`size

`Static` `Readonly`[species]

`Static`groupBy