Class Collection<K, V>

Represents a Collection (Extended from map).

Param: limit

Type Parameters

Hierarchy

Map<K, V>
- Collection

Index

Constructors

constructor

new Collection<K, V>(limit?): Collection<K, V>
Type Parameters
- K
- V
Parameters
- limit: number = Infinity
Returns Collection<K, V>
Overrides Map<K, V>.constructor
- Defined in Desktop/My Portfolio/NPM/dbdteamjs/src/utils/Collection.ts:8

Properties

`Readonly` [toStringTag]

[toStringTag]: string

limit

limit: null | number

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Methods

[iterator]

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

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

clear

clear(): void
Returns void
Inherited from Map.clear
- Defined in AppData/Roaming/npm/node_modules/typedoc/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 AppData/Roaming/npm/node_modules/typedoc/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 AppData/Roaming/npm/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

filter

filter(expression): Collection<K, V>
Parameters
- expression: ((value, key, map) => boolean)
  - - (value, key, map): boolean
    - Parameters
      value: V
      key: K
      map: Map<K, V>
      Returns boolean
Returns Collection<K, V>
- Defined in Desktop/My Portfolio/NPM/dbdteamjs/src/utils/Collection.ts:98

find

find(expression): undefined | V
Parameters
- expression: ((value, key, map) => boolean)
  - - (value, key, map): boolean
    - Parameters
      value: V
      key: K
      map: Map<K, V>
      Returns boolean
Returns undefined | V
- Defined in Desktop/My Portfolio/NPM/dbdteamjs/src/utils/Collection.ts:89

first

first(x?): K | K[]
Returns the first value. (or firsts values)
Parameters
- Optional x: number = 1
  The number of amount values you want to get.
Returns K | K[]
- Defined in Desktop/My Portfolio/NPM/dbdteamjs/src/utils/Collection.ts:55

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: V
      key: K
      map: Map<K, V>
      Returns void
- Optional thisArg: any
Returns void
Inherited from Map.forEach
- Defined in AppData/Roaming/npm/node_modules/typedoc/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 AppData/Roaming/npm/node_modules/typedoc/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 AppData/Roaming/npm/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.collection.d.ts:37

hasAny

hasAny(keys): boolean
Check if the Collection has any value that you are trying to check.
Parameters
- keys: string[]
Returns boolean
- Defined in Desktop/My Portfolio/NPM/dbdteamjs/src/utils/Collection.ts:40

keys

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

Returns IterableIterator<K>
Inherited from Map.keys
- Defined in AppData/Roaming/npm/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

last

last(x?): (K | V)[] | (K | V)[][]
Parameters
- x: number = 1
Returns (K | V)[] | (K | V)[][]
- Defined in Desktop/My Portfolio/NPM/dbdteamjs/src/utils/Collection.ts:67

set

set(key, value): Collection<K, V>
Parameters
- key: any
- value: any
Returns Collection<K, V>
Overrides Map.set
- Defined in Desktop/My Portfolio/NPM/dbdteamjs/src/utils/Collection.ts:80

toJSON

toJSON(): V[]

Returns a the Collection values in a object

Returns V[]

Example

const myFirstCollection = new Collection()

myFirstCollection.set("hi", "hello")
myFirstCollection.set("hallo", "hi")
console.log(myFirstCollection.toJSON()) // ["hello", "hi"]

values

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

Returns IterableIterator<V>
Inherited from Map.values
- Defined in AppData/Roaming/npm/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

`Static` groupBy

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

Class Collection<K, V>

Param: limit

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Collection<K, V>

Properties

Readonly [toStringTag]

limit

Readonly size

Returns

Static Readonly [species]

Methods

[iterator]

Returns IterableIterator<[K, V]>

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns IterableIterator<[K, V]>

filter

Parameters

Parameters

Returns boolean

Returns Collection<K, V>

find

Parameters

Parameters

Returns boolean

Returns undefined | V

first

Parameters

Returns K | K[]

forEach

Parameters

Parameters

Returns void

Returns void

get

Parameters

Returns undefined | V

has

Parameters

Returns boolean

hasAny

Parameters

Returns boolean

keys

Returns IterableIterator<K>

last

Parameters

Returns (K | V)[] | (K | V)[][]

set

Parameters

Returns Collection<K, V>

toJSON

Returns V[]

Example

values

Returns IterableIterator<V>

Static groupBy

Type Parameters

Parameters

Parameters

Returns K

Returns Map<K, T[]>

Settings

Member Visibility

Theme

On This Page

`Readonly` [toStringTag]

`Readonly` size

`Static` `Readonly` [species]

`Static` groupBy