Class Collection<K, V>

A Map with some Array-like additions.

Type Parameters

Hierarchy (view full)

Map<K, V>
- Collection
  - TypedCollection

Index

Constructors

constructor

new Collection<K, V>(entries?): Collection<K, V>
Type Parameters
- K
- V
Parameters
- Optionalentries: 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:50
new Collection<K, V>(iterable?): Collection<K, V>
Type Parameters
- K
- V
Parameters
- Optionaliterable: null | Iterable<readonly [K, V]>
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/util/Collection.ts:13

Methods

[iterator]

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

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

clear

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

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

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

every

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

filter

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

find

find<S, ThisArg>(predicate, 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, value, index, obj): value is S
    - Parameters
      this: ThisArg
      value: V
      index: number
      obj: V[]
      Returns value is S
- OptionalthisArg: ThisArg
Returns undefined | S
- Defined in lib/util/Collection.ts:34
find<ThisArg>(predicate, thisArg?): undefined | V
Type Parameters
- ThisArg = Collection<K, V>
Parameters
- predicate: ((this: ThisArg, value: V, index: number, obj: V[]) => unknown)
  - - (this, value, index, obj): unknown
    - Parameters
      this: ThisArg
      value: V
      index: number
      obj: V[]
      Returns unknown
- OptionalthisArg: ThisArg
Returns undefined | V
- Defined in lib/util/Collection.ts:35

findIndex

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

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:49
first(amount): V[]
Parameters
- amount: number
Returns V[]
- Defined in lib/util/Collection.ts:50

forEach

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

get

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

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:70
last(amount): V[]
Parameters
- amount: number
Returns V[]
- Defined in lib/util/Collection.ts:71

map

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

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

reduce

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

reduceRight

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

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

some

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

toArray

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

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

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

Class Collection<K, V>

Type Parameters

Hierarchy (view full)

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 IterableIterator<[K, V]>

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns IterableIterator<[K, V]>

every

Type Parameters

Parameters

Parameters

Returns value is T

Returns this is T[]

Type Parameters

Parameters

Parameters

Returns unknown

Returns boolean

filter

Type Parameters

Parameters

Parameters

Returns value is S

Returns S[]

Type Parameters

Parameters

Parameters

Returns unknown

Returns V[]

find

Type Parameters

Parameters

Parameters

Returns value is S

Returns undefined | S

Type Parameters

Parameters

Parameters

Returns unknown

Returns undefined | V

findIndex

Parameters

Parameters

Returns unknown

Returns number

first

Returns undefined | V

Parameters

Returns V[]

forEach

Parameters

Parameters

Returns void

`Readonly`[toStringTag]

`Readonly`size

`Static` `Readonly`[species]