Collection | oldschooljs

A Map with additional utility methods.

Type parameters

Hierarchy

Map<K, V>
- Collection
  - Items
  - News
  - Polls
  - Worlds

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Collection(entries?: readonly readonly [K, V][] | null): Collection

- Defined in src/structures/Collection.ts:26
Parameters
- Optional entries: readonly readonly [K, V][] | null
Returns Collection

Properties

Readonly [Symbol.toStringTag]

[Symbol.toStringTag]: string

Private _array

_array: V[] | null

Private _keyArray

_keyArray: K[] | null

Readonly size

size: number

returns: the number of elements in the Map.

Static Map

Map: MapConstructor

Static Readonly default

default: typeof Collection = Collection

Methods

[Symbol.iterator]

[Symbol.iterator](): IterableIterator<[K, V]>

Inherited from Collection.[Symbol.iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:121
Returns an iterable of entries in the map.

Returns IterableIterator<[K, V]>

array

array(): V[]

- Defined in src/structures/Collection.ts:71
Creates an ordered array of the values of this collection, and caches it internally. The array will only be reconstructed if an item is added to or removed from the collection, or if you change the length of the array itself. If you don't want this caching behavior, use [...collection.values()] or Array.from(collection.values()) instead.

Returns V[]

clear

clear(): void

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

clone

clone(): Collection<K, V>

- Defined in src/structures/Collection.ts:396
Creates an identical shallow copy of this collection.

example

const newColl = someColl.clone();

Returns Collection<K, V>

concat

concat(...collections: Collection<K, V>[]): Collection<K, V>

- Defined in src/structures/Collection.ts:407
Combines this collection with others into a new collection. None of the source collections are modified.

example

const newColl = someColl.concat(someOtherColl, anotherColl, ohBoyAColl);

Parameters
- Rest ...collections: Collection<K, V>[]
  
  Collections to merge
Returns Collection<K, V>

delete

delete(key: K): boolean

Overrides Map.delete
- Defined in src/structures/Collection.ts:58
Parameters
- key: K
Returns boolean

each

each(fn: (value: V, key: K, collection: Map<K, V>) => any, thisArg?: any): this

- Defined in src/structures/Collection.ts:370
Identical to Map.forEach(), but returns the collection instead of undefined.

example

collection .each(user => console.log(user.username)) .filter(user => user.bot) .each(user => console.log(user.username));

Parameters
- fn: (value: V, key: K, collection: Map<K, V>) => any
  
  Function to execute for each element
  - - (value: V, key: K, collection: Map<K, V>): any
    - Parameters
      - value: V
      - key: K
      - collection: Map<K, V>
      Returns any
- Optional thisArg: any
Returns this

entries

entries(): IterableIterator<[K, V]>

Inherited from Collection.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:126
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[K, V]>

equals

equals(collection: Collection<K, V>): boolean

- Defined in src/structures/Collection.ts:422
Checks if this collection shares identical key-value pairings with another. This is different to checking for equality using equal-signs, because the collections may be different objects, but contain the same data.

Parameters
- collection: Collection<K, V>
  
  Collection to compare with
Returns boolean

Whether the collections have identical contents

every

every(fn: (value: V, key: K, collection: this) => boolean): boolean

- Defined in src/structures/Collection.ts:314
Checks if all items passes a test. Identical in behavior to Array.every().

example

collection.every(user => !user.bot);

Parameters
- fn: (value: V, key: K, collection: this) => boolean
  
  Function used to test (should return a boolean)
  - - (value: V, key: K, collection: this): boolean
    - Parameters
      - value: V
      - key: K
      - collection: this
      Returns boolean
Returns boolean

filter

filter(fn: (value: V, key: K, collection: this) => boolean): Collection<K, V>

- Defined in src/structures/Collection.ts:251
Identical to Array.filter(), but returns a Collection instead of an Array.

example

collection.filter(user => user.username === 'Bob');

Parameters
- fn: (value: V, key: K, collection: this) => boolean
  
  The function to test with (should return boolean)
  - - (value: V, key: K, collection: this): boolean
    - Parameters
      - value: V
      - key: K
      - collection: this
      Returns boolean
Returns Collection<K, V>

find

find(fn: (value: V, key: K, collection: this) => boolean): V | undefined

- Defined in src/structures/Collection.ts:200
Searches for a single item where the given function returns a truthy value. This behaves like Array.find(). All collections used in Discord.js are mapped using their id property, and if you want to find by id you should use the get method. See MDN for details.

example

collection.find(user => user.username === 'Bob');

Parameters
- fn: (value: V, key: K, collection: this) => boolean
  
  The function to test with (should return boolean)
  - - (value: V, key: K, collection: this): boolean
    - Parameters
      - value: V
      - key: K
      - collection: this
      Returns boolean
Returns V | undefined

findKey

findKey(fn: (value: V, key: K, collection: this) => boolean, thisArg?: any): K | undefined

- Defined in src/structures/Collection.ts:216
Searches for the key of a single item where the given function returns a truthy value. This behaves like Array.findIndex(), but returns the key rather than the positional index.

example

collection.findKey(user => user.username === 'Bob');

Parameters
- fn: (value: V, key: K, collection: this) => boolean
  
  The function to test with (should return boolean)
  - - (value: V, key: K, collection: this): boolean
    - Parameters
      - value: V
      - key: K
      - collection: this
      Returns boolean
- Optional thisArg: any
Returns K | undefined

first

first(): V | undefined
first(amount: number): V[]

- Defined in src/structures/Collection.ts:94
Obtains the first value(s) in this collection.

Returns V | undefined

A single value if no amount is provided or an array of values, starting from the end if amount is negative
- Defined in src/structures/Collection.ts:95
Parameters
- amount: number
Returns V[]

firstKey

firstKey(): K | undefined
firstKey(amount: number): K[]

- Defined in src/structures/Collection.ts:110
Obtains the first key(s) in this collection.

Returns K | undefined

A single key if no amount is provided or an array of keys, starting from the end if amount is negative
- Defined in src/structures/Collection.ts:111
Parameters
- amount: number
Returns K[]

forEach

forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any): void

Inherited from Collection.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:31
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

get

get(key: K): V | undefined

Inherited from Collection.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:36
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.

has

has(key: K): boolean

Inherited from Collection.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:40
Parameters
- key: K
Returns boolean

boolean indicating whether an element with the specified key exists or not.

keyArray

keyArray(): K[]

- Defined in src/structures/Collection.ts:83
Creates an ordered array of the keys of this collection, and caches it internally. The array will only be reconstructed if an item is added to or removed from the collection, or if you change the length of the array itself. If you don't want this caching behavior, use [...collection.keys()] or Array.from(collection.keys()) instead.

Returns K[]

keys

keys(): IterableIterator<K>

Inherited from Collection.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:131
Returns an iterable of keys in the map

Returns IterableIterator<K>

last

last(): V | undefined
last(amount: number): V[]

- Defined in src/structures/Collection.ts:127
Obtains the last value(s) in this collection. This relies on {@link Collection#array}, and thus the caching mechanism applies here as well.

Returns V | undefined

A single value if no amount is provided or an array of values, starting from the start if amount is negative
- Defined in src/structures/Collection.ts:128
Parameters
- amount: number
Returns V[]

lastKey

lastKey(): K | undefined
lastKey(amount: number): K[]

- Defined in src/structures/Collection.ts:144
Obtains the last key(s) in this collection. This relies on {@link Collection#keyArray}, and thus the caching mechanism applies here as well.

Returns K | undefined

A single key if no amount is provided or an array of keys, starting from the start if amount is negative
- Defined in src/structures/Collection.ts:145
Parameters
- amount: number
Returns K[]

map

map<T>(fn: (value: V, key: K, collection: this) => T): T[]

- Defined in src/structures/Collection.ts:268
Maps each item to another value into an array. Identical in behavior to Array.map().

example

collection.map(user => user.tag);

Type parameters
- T
Parameters
- fn: (value: V, key: K, collection: this) => T
  
  Function that produces an element of the new array, taking three arguments
  - - (value: V, key: K, collection: this): T
    - Parameters
      - value: V
      - key: K
      - collection: this
      Returns T
Returns T[]

mapValues

mapValues<T>(fn: (value: V, key: K, collection: this) => T): Collection<K, T>

- Defined in src/structures/Collection.ts:284
Maps each item to another value into a collection. Identical in behavior to Array.map().

example

collection.mapValues(user => user.tag);

Type parameters
- T
Parameters
- fn: (value: V, key: K, collection: this) => T
  
  Function that produces an element of the new collection, taking three arguments
  - - (value: V, key: K, collection: this): T
    - Parameters
      - value: V
      - key: K
      - collection: this
      Returns T
Returns Collection<K, T>

random

random(): V
random(amount: number): V[]

- Defined in src/structures/Collection.ts:160
Obtains unique random value(s) from this collection. This relies on {@link Collection#array}, and thus the caching mechanism applies here as well.

Returns V

A single value if no amount is provided or an array of values
- Defined in src/structures/Collection.ts:161
Parameters
- amount: number
Returns V[]

randomKey

randomKey(): K
randomKey(amount: number): K[]

- Defined in src/structures/Collection.ts:176
Obtains unique random key(s) from this collection. This relies on {@link Collection#keyArray}, and thus the caching mechanism applies here as well.

Returns K

A single key if no amount is provided or an array
- Defined in src/structures/Collection.ts:177
Parameters
- amount: number
Returns K[]

reduce

reduce<T>(fn: (accumulator: any, value: V, key: K, collection: this) => T, initialValue?: T): T

- Defined in src/structures/Collection.ts:330
Applies a function to produce a single value. Identical in behavior to Array.reduce().

example

collection.reduce((acc, guild) => acc + guild.memberCount, 0);

Type parameters
- T
Parameters
- fn: (accumulator: any, value: V, key: K, collection: this) => T
  
  Function used to reduce, taking four arguments; accumulator, currentValue, currentKey, and collection
  - - (accumulator: any, value: V, key: K, collection: this): T
    - Parameters
      - accumulator: any
      - value: V
      - key: K
      - collection: this
      Returns T
- Optional initialValue: T
Returns T

set

set(key: K, value: V): this

Overrides Map.set
- Defined in src/structures/Collection.ts:52
Parameters
- key: K
- value: V
Returns this

some

some(fn: (value: V, key: K, collection: this) => boolean): boolean

- Defined in src/structures/Collection.ts:299
Checks if there exists an item that passes a test. Identical in behavior to Array.some().

example

collection.some(user => user.discriminator === '0000');

Parameters
- fn: (value: V, key: K, collection: this) => boolean
  
  Function used to test (should return a boolean)
  - - (value: V, key: K, collection: this): boolean
    - Parameters
      - value: V
      - key: K
      - collection: this
      Returns boolean
Returns boolean

sort

sort(compareFunction?: (firstValue: V, secondValue: V, firstKey: K, secondKey: K) => number): this

- Defined in src/structures/Collection.ts:443
The sort() method sorts the elements of a collection and returns it. The sort is not necessarily stable. The default sort order is according to string Unicode code points.

example

collection.sort((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);

Parameters
- Default value compareFunction: (firstValue: V, secondValue: V, firstKey: K, secondKey: K) => number = (x, y): number =>Number(x > y) || Number(x === y) - 1
  - - (firstValue: V, secondValue: V, firstKey: K, secondKey: K): number
    - Parameters
      - firstValue: V
      - secondValue: V
      - firstKey: K
      - secondKey: K
      Returns number
Returns this

sweep

sweep(fn: (value: V, key: K, collection: this) => boolean): number

- Defined in src/structures/Collection.ts:234
Removes entries that satisfy the provided filter function.

Parameters
- fn: (value: V, key: K, collection: this) => boolean
  
  Function used to test (should return a boolean)
  - - (value: V, key: K, collection: this): boolean
    - Parameters
      - value: V
      - key: K
      - collection: this
      Returns boolean
Returns number

The number of removed entries

tap

tap(fn: (collection: this) => any): this

- Defined in src/structures/Collection.ts:386
Runs a function on the collection and returns the collection.

example

collection .tap(coll => console.log(coll.size)) .filter(user => user.bot) .tap(coll => console.log(coll.size))

Parameters
- fn: (collection: this) => any
  
  Function to execute
  - - (collection: this): any
    - Parameters
      - collection: this
      Returns any
Returns this

values

values(): IterableIterator<V>

Inherited from Collection.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:136
Returns an iterable of values in the map

Returns IterableIterator<V>

Type parameters

K

V

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

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

Returns Collection

Properties

Readonly [Symbol.toStringTag]

Private _array

Private _keyArray

Readonly size

Static Map

Static Readonly default

Methods

[Symbol.iterator]

Returns IterableIterator<[K, V]>

array

Returns V[]

clear

Returns void

clone

Returns Collection<K, V>

concat

Parameters

Rest ...collections: Collection<K, V>[]

Returns Collection<K, V>

delete

Parameters

key: K

Returns boolean

each

Parameters

fn: (value: V, key: K, collection: Map<K, V>) => any

Parameters

value: V

key: K

collection: Map<K, V>

Returns any

Optional thisArg: any

Returns this

entries

Returns IterableIterator<[K, V]>

equals

Parameters

collection: Collection<K, V>

Returns boolean

every

Parameters

fn: (value: V, key: K, collection: this) => boolean

Parameters

value: V

key: K

collection: this

Returns boolean

Returns boolean

filter

Parameters

fn: (value: V, key: K, collection: this) => boolean

Parameters

value: V

key: K

collection: this

Returns boolean

Returns Collection<K, V>

find

Parameters

fn: (value: V, key: K, collection: this) => boolean

Parameters

value: V

key: K

collection: this

Returns boolean

Returns V | undefined