Class: Collection<T>
Extends
Map
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
T | object |
Constructors
new Collection()
new Collection<
T>():Collection<T>
Returns
Collection<T>
Inherited from
Map.constructor
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:49
new Collection()
new Collection<
T>():Collection<T>
Returns
Collection<T>
Inherited from
Map.constructor
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:49
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
[toStringTag] | readonly | string | - | Map.[toStringTag] | node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:137 |
size | readonly | number | Map.size | node_modules/typescript/lib/lib.es2015.collection.d.ts:45 | |
[species] | readonly | MapConstructor | - | Map.[species] | node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:319 |
Methods
[iterator]()
[iterator]():
IterableIterator<[any,any]>
Returns an iterable of entries in the map.
Returns
IterableIterator<[any, any]>
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
| Parameter | Type |
|---|---|
key | any |
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<[any,any]>
Returns an iterable of key, value pairs for every entry in the map.
Returns
IterableIterator<[any, any]>
Inherited from
Map.entries
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:124
first()
first():
T
Returns
T
Defined in
src/core/classes/Collection.ts:23 (opens in a new tab)
forEach()
forEach(
callbackfn,thisArg?):void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
| Parameter | Type |
|---|---|
callbackfn | (value, key, map) => void |
thisArg? | any |
Returns
void
Inherited from
Map.forEach
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:28
get()
get<
V>(key):null|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.
Type Parameters
| Type Parameter |
|---|
V |
Parameters
| Parameter | Type |
|---|---|
key | any |
Returns
null | V
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Overrides
Map.get
Defined in
src/core/classes/Collection.ts:4 (opens in a new tab)
has()
has(
key):boolean
Parameters
| Parameter | Type |
|---|---|
key | any |
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<any>
Returns an iterable of keys in the map
Returns
IterableIterator<any>
Inherited from
Map.keys
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:129
last()
last():
T
Returns
T
Defined in
src/core/classes/Collection.ts:27 (opens in a new tab)
random()
random():
T
Returns
T
Defined in
src/core/classes/Collection.ts:31 (opens in a new tab)
remove()
remove(
key):boolean
Parameters
| Parameter | Type |
|---|---|
key | any |
Returns
boolean
Defined in
src/core/classes/Collection.ts:15 (opens in a new tab)
set()
set<
V>(key,value):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.
Type Parameters
| Type Parameter |
|---|
V |
Parameters
| Parameter | Type |
|---|---|
key | any |
value | V |
Returns
V
Overrides
Map.set
Defined in
src/core/classes/Collection.ts:9 (opens in a new tab)
toArray()
toArray():
T[]
Returns
T[]
Defined in
src/core/classes/Collection.ts:19 (opens in a new tab)
values()
values():
IterableIterator<any>
Returns an iterable of values in the map
Returns
IterableIterator<any>
Inherited from
Map.values
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:134