Class Collection<K, V>

A Map with some Array-like additions.

Type Parameters

Hierarchy

Map<K, V>
- Collection
  - TypedCollection

Index

Constructors

constructor

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

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/util/Collection.ts:8

Methods

[iterator]

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

Returns IterableIterator<[K, V]>
Inherited from Map.__@iterator@928
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:121

clear

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

delete

delete(key: K): boolean
Returns
true if an element in the Map existed and has been removed, or false if the element does not exist.
Parameters
- key: K
Returns boolean
Inherited from Map.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:27

entries

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

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

every

every<T, ThisArg>(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)
  - - (value: V, index: number, array: V[]): value is T
    - Parameters
      
      value: V
      
      index: number
      
      array: V[]
      
      Returns value is T
- Optional thisArg: ThisArg
Returns this is T[]
- Defined in lib/util/Collection.ts:13
every<ThisArg>(predicate: ((value: V, index: number, array: V[]) => unknown), thisArg?: ThisArg): boolean
Type Parameters
- ThisArg = Collection<K, V>
Parameters
- predicate: ((value: V, index: number, array: V[]) => unknown)
  - - (value: V, index: number, array: V[]): unknown
    - Parameters
      
      value: V
      
      index: number
      
      array: V[]
      
      Returns unknown
- Optional thisArg: ThisArg
Returns boolean
- Defined in lib/util/Collection.ts:14

filter

filter<S, ThisArg>(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)
  - - (this: ThisArg, value: V, index: number, array: V[]): value is S
    - Parameters
      
      this: ThisArg
      
      value: V
      
      index: number
      
      array: V[]
      
      Returns value is S
- Optional thisArg: ThisArg
Returns S[]
- Defined in lib/util/Collection.ts:22
filter<ThisArg>(predicate: ((this: ThisArg, value: V, index: number, array: V[]) => unknown), thisArg?: ThisArg): V[]
Type Parameters
- ThisArg = Collection<K, V>
Parameters
- predicate: ((this: ThisArg, value: V, index: number, array: V[]) => unknown)
  - - (this: ThisArg, value: V, index: number, array: V[]): unknown
    - Parameters
      
      this: ThisArg
      
      value: V
      
      index: number
      
      array: V[]
      
      Returns unknown
- Optional thisArg: ThisArg
Returns V[]
- Defined in lib/util/Collection.ts:23

find

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

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)
  - - (value: V, index: number, obj: V[]): unknown
    - Parameters
      
      value: V
      
      index: number
      
      obj: V[]
      
      Returns unknown
- Optional thisArg: unknown
Returns number
- Defined in lib/util/Collection.ts:36

first

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

Returns undefined | V
- Defined in lib/util/Collection.ts:44
first(amount: number): V[]
Parameters
- amount: number
Returns V[]
- Defined in lib/util/Collection.ts:45

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)
  - - (value: V, key: K, map: Map<K, V>): void
    - Parameters
      
      value: V
      
      key: K
      
      map: Map<K, V>
      
      Returns void
- Optional thisArg: any
Returns void
Inherited from Map.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:31

get

get(key: K): undefined | V
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.

Returns
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Parameters
- key: K
Returns undefined | V
Inherited from Map.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:36

has

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

keys

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

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

last

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

Returns undefined | V
- Defined in lib/util/Collection.ts:65
last(amount: number): V[]
Parameters
- amount: number
Returns V[]
- Defined in lib/util/Collection.ts:66

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)
  - - (value: V, index: number, obj: V[]): T
    - Parameters
      
      value: V
      
      index: number
      
      obj: V[]
      
      Returns T
- Optional thisArg: unknown
Returns T[]
- Defined in lib/util/Collection.ts:83

random

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

Returns undefined | V
- Defined in lib/util/Collection.ts:90

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)
  - - (previousValue: V, currentValue: V, currentIndex: number, array: V[]): V
    - Parameters
      
      previousValue: V
      
      currentValue: V
      
      currentIndex: number
      
      array: V[]
      
      Returns V
Returns V
- Defined in lib/util/Collection.ts:100
reduce(predicate: ((previousValue: V, currentValue: V, currentIndex: number, array: V[]) => V), initialValue: V): V
Parameters
- predicate: ((previousValue: V, currentValue: V, currentIndex: number, array: V[]) => V)
  - - (previousValue: V, currentValue: V, currentIndex: number, array: V[]): V
    - Parameters
      
      previousValue: V
      
      currentValue: V
      
      currentIndex: number
      
      array: V[]
      
      Returns V
- initialValue: V
Returns V
- Defined in lib/util/Collection.ts:101
reduce<T>(predicate: ((previousValue: T, currentValue: V, currentIndex: number, array: V[]) => T), initialValue: T): T
Type Parameters
- T
Parameters
- predicate: ((previousValue: T, currentValue: V, currentIndex: number, array: V[]) => T)
  - - (previousValue: T, currentValue: V, currentIndex: number, array: V[]): T
    - Parameters
      
      previousValue: T
      
      currentValue: V
      
      currentIndex: number
      
      array: V[]
      
      Returns T
- initialValue: T
Returns T
- Defined in lib/util/Collection.ts:102

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)
  - - (previousValue: V, currentValue: V, currentIndex: number, array: V[]): V
    - Parameters
      
      previousValue: V
      
      currentValue: V
      
      currentIndex: number
      
      array: V[]
      
      Returns V
Returns V
- Defined in lib/util/Collection.ts:108
reduceRight(predicate: ((previousValue: V, currentValue: V, currentIndex: number, array: V[]) => V), initialValue: V): V
Parameters
- predicate: ((previousValue: V, currentValue: V, currentIndex: number, array: V[]) => V)
  - - (previousValue: V, currentValue: V, currentIndex: number, array: V[]): V
    - Parameters
      
      previousValue: V
      
      currentValue: V
      
      currentIndex: number
      
      array: V[]
      
      Returns V
- initialValue: V
Returns V
- Defined in lib/util/Collection.ts:109
reduceRight<T>(predicate: ((previousValue: T, currentValue: V, currentIndex: number, array: V[]) => T), initialValue: T): T
Type Parameters
- T
Parameters
- predicate: ((previousValue: T, currentValue: V, currentIndex: number, array: V[]) => T)
  - - (previousValue: T, currentValue: V, currentIndex: number, array: V[]): T
    - Parameters
      
      previousValue: T
      
      currentValue: V
      
      currentIndex: number
      
      array: V[]
      
      Returns T
- initialValue: T
Returns T
- Defined in lib/util/Collection.ts:110

set

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

some

some<ThisArg>(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)
  - - (value: V, index: number, array: V[]): unknown
    - Parameters
      
      value: V
      
      index: number
      
      array: V[]
      
      Returns unknown
- Optional thisArg: ThisArg
Returns boolean
- Defined in lib/util/Collection.ts:116

toArray

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

Returns V[]
- Defined in lib/util/Collection.ts:121

values

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

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

Class Collection<K, V>

Type Parameters

K

V

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

K

V

Parameters

Optional entries: null | readonly (readonly [K, V])[]

Returns Collection<K, V>

Type Parameters

K

V

Parameters

Optional iterable: null | Iterable<readonly [K, V]>

Returns Collection<K, V>

Properties

Readonly [toStringTag]

Readonly size

Returns

Static Readonly [species]

Accessors

empty

Returns boolean

Methods

[iterator]

Returns IterableIterator<[K, V]>

clear

Returns void

delete

Returns

Parameters

key: K

Returns boolean

entries

Returns IterableIterator<[K, V]>

every

Type Parameters

T

ThisArg = Collection<K, V>

Parameters

predicate: ((value: V, index: number, array: V[]) => value is T)

Parameters

value: V

index: number

array: V[]

Returns value is T

Optional thisArg: ThisArg

Returns this is T[]

Type Parameters

ThisArg = Collection<K, V>

Parameters

predicate: ((value: V, index: number, array: V[]) => unknown)

Parameters

value: V

index: number

array: V[]

Returns unknown

Optional thisArg: ThisArg

Returns boolean

filter

Type Parameters

S

ThisArg = Collection<K, V>

Parameters

predicate: ((this: ThisArg, value: V, index: number, array: V[]) => value is S)

Parameters

this: ThisArg

value: V

index: number

array: V[]

Returns value is S

`Optional` entries: null | readonly (readonly [K, V])[]

`Optional` iterable: null | Iterable<readonly [K, V]>

`Readonly` [toStringTag]

`Readonly` size

`Static` `Readonly` [species]

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: ThisArg

`Optional` thisArg: unknown

`Optional` thisArg: any