Collection | Avocord

An utility data structure used within the Discordoo.

Type Parameters

K = any
V = any

Hierarchy

Map<K, V>
- Collection

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Collection<K, V>(iterable: Iterable<readonly [K, V]>): Collection<K, V>
new Collection<K, V>(entries?: null | readonly (readonly [K, V])[]): Collection<K, V>

Overrides Map<K, V>.constructor
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:11
The Collection() constructor creates Collection objects.

Type Parameters
- K = any
- V = any
Parameters
- iterable: Iterable<readonly [K, V]>
Returns Collection<K, V>
Overrides Map<K, V>.constructor
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:12
Type Parameters
- K = any
- V = any
Parameters
- Optional entries: null | readonly (readonly [K, V])[]
Returns Collection<K, V>

Properties

Readonly [toStringTag]

[toStringTag]: string

Static Readonly [species]

[species]: MapConstructor

Accessors

[species]

get [species](): Function

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:13
Returns Function

empty

get empty(): boolean

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:46
Checks if the collection is empty or not.

Returns boolean

size

get size(): number

Overrides Map.size
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:42
Gets the amount of elements in this collection.

Returns number

Methods

[iterator]

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

Inherited from Map.__@iterator@109
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:121
Returns an iterable of entries in the map.

Returns IterableIterator<[K, V]>

clear

clear(): void

Overrides Map.clear
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:38
Removes all elements from the collection.

Returns void

clone

clone(): Collection<K, V>

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:139
Creates a new collection based on this one.

Returns Collection<K, V>

concat

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

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:150
Merges the specified collections into one and returns a new collection.

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

delete

delete(key: K): boolean

Overrides Map.delete
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:34
Removes element from the collection.

Parameters
- key: K
  
  key of element
Returns boolean

entries

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

Inherited from Map.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]>

equal

equal(collection: Collection<K, V>, options?: CollectionEqualOptions): boolean

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:145
Checks if two collections are equal.

Parameters
- collection: Collection<K, V>
  
  collection to compare to
- Optional options: CollectionEqualOptions
  
  options to use
Returns boolean

every

every(predicate: ((value: V, key: K, collection: Collection<K, V>) => boolean)): boolean

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:160
Checks if all values satisfy the condition.

Parameters
- predicate: ((value: V, key: K, collection: Collection<K, V>) => boolean)
  
  function to use
  - - (value: V, key: K, collection: Collection<K, V>): boolean
    - Parameters
      - value: V
      - key: K
      - collection: Collection<K, V>
      Returns boolean
Returns boolean

filter

filter<T>(filter: ((value: V, key: K, collection: Collection<K, V>) => boolean), options?: CollectionFilterOptions): [K, V][]
filter<T>(filter: ((value: V, key: K, collection: Collection<K, V>) => boolean), options: CollectionFilterOptions): Collection<K, V>
filter<T>(filter: ((value: V, key: K, collection: Collection<K, V>) => boolean), options: CollectionFilterOptions): Map<K, V>

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:106
Filters out the elements which don't meet requirements and returns array (default).

Type Parameters
- T extends [K, V][] = [K, V][]
Parameters
- filter: ((value: V, key: K, collection: Collection<K, V>) => boolean)
  
  function to use
  - - (value: V, key: K, collection: Collection<K, V>): boolean
    - Parameters
      - value: V
      - key: K
      - collection: Collection<K, V>
      Returns boolean
- Optional options: CollectionFilterOptions
  
  filter options
Returns [K, V][]
- array of [ Key, Value ]
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:113
Filters out the elements which don't meet requirements and returns collection (return collection option is specified).

Type Parameters
- T extends Collection<any, any, T> = Collection<K, V>
Parameters
- filter: ((value: V, key: K, collection: Collection<K, V>) => boolean)
  
  function to use
  - - (value: V, key: K, collection: Collection<K, V>): boolean
    - Parameters
      - value: V
      - key: K
      - collection: Collection<K, V>
      Returns boolean
- options: CollectionFilterOptions
  
  filter options
Returns Collection<K, V>
- collection Key -> Value
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:120
Filters out the elements which don't meet requirements and returns map (return map option is specified).

Type Parameters
- T extends Map<K, V, T> = Map<K, V>
Parameters
- filter: ((value: V, key: K, collection: Collection<K, V>) => boolean)
  
  function to use
  - - (value: V, key: K, collection: Collection<K, V>): boolean
    - Parameters
      - value: V
      - key: K
      - collection: Collection<K, V>
      Returns boolean
- options: CollectionFilterOptions
  
  filter options
Returns Map<K, V>
- map Key -> Value

find

find(predicate: ((value: V, key: K, collection: Collection<K, V>) => boolean)): undefined | V

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:125
Searches for the element in collection and returns it.

Parameters
- predicate: ((value: V, key: K, collection: Collection<K, V>) => boolean)
  
  function to use
  - - (value: V, key: K, collection: Collection<K, V>): boolean
    - Parameters
      - value: V
      - key: K
      - collection: Collection<K, V>
      Returns boolean
Returns undefined | V

findKey

findKey(predicate: ((value: V, key: K, collection: Collection<K, V>) => boolean)): undefined | K

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:130
Searches for the key in collection and returns it.

Parameters
- predicate: ((value: V, key: K, collection: Collection<K, V>) => boolean)
  
  function to use
  - - (value: V, key: K, collection: Collection<K, V>): boolean
    - Parameters
      - value: V
      - key: K
      - collection: Collection<K, V>
      Returns boolean
Returns undefined | K

first

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

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:164
Returns first collection value if it exists.

Returns undefined | V
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:168
Returns first N collection values.

Parameters
- amount: number
Returns V[]

firstKey

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

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:172
Returns first collection key if it exists.

Returns undefined | K
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:176
Returns first N collection keys.

Parameters
- amount: number
Returns K[]

forEach

forEach(predicate: ((value: V, key: K, collection: Collection<K, V>) => any)): void

Overrides Map.forEach
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:135
Executes a function on each of elements of collection.

Parameters
- predicate: ((value: V, key: K, collection: Collection<K, V>) => any)
  
  function to use
  - - (value: V, key: K, collection: Collection<K, V>): any
    - Parameters
      - value: V
      - key: K
      - collection: Collection<K, V>
      Returns any
Returns void

get

get(key: K): undefined | V

Overrides Map.get
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:18
Gets element from collection.

Parameters
- key: K
  
  key of element
Returns undefined | V

has

has(key: K): boolean

Overrides Map.has
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:29
Checks if an element exists in the collection.

Parameters
- key: K
  
  key of element
Returns boolean

intoChunks

intoChunks(size?: number): Collection<K, V>[]

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:208
Returns a collection chunked into several collections.

Parameters
- Optional size: number
  
  chunk size
Returns Collection<K, V>[]

keys

keys(): IterableIterator<K>

Inherited from Map.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(): undefined | V
last(amount: number): V[]

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:180
Returns last collection value if it exists.

Returns undefined | V
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:184
Returns last N collection values.

Parameters
- amount: number
Returns V[]

lastKey

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

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:188
Returns last collection key if it exists.

Returns undefined | K
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:192
Returns first N collection keys.

Parameters
- amount: number
Returns K[]

map

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

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:197
Maps each item to another value into an array.

Type Parameters
- T = any
Parameters
- predicate: ((value: V, key: K, collection: Collection<K, V>) => T)
  
  function to use
  - - (value: V, key: K, collection: Collection<K, V>): T
    - Parameters
      - value: V
      - key: K
      - collection: Collection<K, V>
      Returns T
Returns T[]

random

random(): V
random(amount: number): V[]
random<T>(amount: number, options: CollectionRandomOptions): V[]
random<T>(amount: number, options: CollectionRandomOptions): K[]
random<T>(amount: number, options: CollectionRandomOptions): [K, V][]
random<T>(amount: undefined, options: CollectionRandomOptions): V
random<T>(amount: undefined, options: CollectionRandomOptions): K
random<T>(amount: undefined, options: CollectionRandomOptions): [K, V]

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:51
Gets a random value from collection.

Returns V
- value
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:57
Gets a random values from collection.

Parameters
- amount: number
  
  amount of values to get
Returns V[]
- array of values
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:64
Gets a random values from collection (returnType values option is specified).

Type Parameters
- T extends V[]
Parameters
- amount: number
  
  amount of values to get
- options: CollectionRandomOptions
  
  method options
Returns V[]
- array of values
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:71
Gets a random keys from collection (returnType keys option is specified).

Type Parameters
- T extends K[]
Parameters
- amount: number
  
  amount of values to get
- options: CollectionRandomOptions
  
  method options
Returns K[]
- array of keys
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:78
Gets a random blocks from collection (returnType blocks option is specified).

Type Parameters
- T extends [K, V][]
Parameters
- amount: number
  
  amount of values to get
- options: CollectionRandomOptions
  
  method options
Returns [K, V][]
- array of blocks [ Key, Value ]
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:85
Gets a random value from collection (returnType values option is specified, amount not specified).

Type Parameters
- T
Parameters
- amount: undefined
  
  not specified in this case
- options: CollectionRandomOptions
  
  method options
Returns V
- value
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:92
Gets a random key from collection (returnType keys option is specified, amount not specified).

Type Parameters
- T
Parameters
- amount: undefined
  
  not specified in this case
- options: CollectionRandomOptions
  
  method options
Returns K
- key
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:99
Gets a random block from collection (returnType block option is specified, amount not specified).

Type Parameters
- T extends [K, V]
Parameters
- amount: undefined
  
  not specified in this case
- options: CollectionRandomOptions
  
  method options
Returns [K, V]
- block [ Key, Value ]

reduce

reduce<T>(predicate: ((accumulator: T, value: V, key: K, collection: Collection<K, V>) => T), initialValue?: T): T

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:203
Executes a predicate function on each element of the collection, resulting in a single output value.

Type Parameters
- T = any
Parameters
- predicate: ((accumulator: T, value: V, key: K, collection: Collection<K, V>) => T)
  
  function to use
  - - (accumulator: T, value: V, key: K, collection: Collection<K, V>): T
    - Parameters
      - accumulator: T
      - value: V
      - key: K
      - collection: Collection<K, V>
      Returns T
- Optional initialValue: T
  
  initial value for the accumulator
Returns T

set

set(key: K, value: V): Collection<K, V>

Overrides Map.set
- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:24
Sets a new element in the collection.

Parameters
- key: K
  
  key of element
- value: V
  
  value (element) to set
Returns Collection<K, V>

some

some(predicate: ((value: V, key: K, collection: Collection<K, V>) => boolean)): boolean

- Defined in node_modules/@discordoo/collection/types/Collection.d.ts:155
Checks if any of values satisfies the condition.

Parameters
- predicate: ((value: V, key: K, collection: Collection<K, V>) => boolean)
  
  function to use
  - - (value: V, key: K, collection: Collection<K, V>): boolean
    - Parameters
      - value: V
      - key: K
      - collection: Collection<K, V>
      Returns boolean
Returns boolean

values

values(): IterableIterator<V>

Inherited from Map.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 = any

V = any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

K = any

V = any

Parameters

iterable: Iterable<readonly [K, V]>

Returns Collection<K, V>

Type Parameters

K = any

V = any

Parameters

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

Returns Collection<K, V>

Properties

Readonly [toStringTag]

Static Readonly [species]

Accessors

[species]

Returns Function

empty

Returns boolean

size

Returns number

Methods

[iterator]

Returns IterableIterator<[K, V]>

clear

Returns void

clone

Returns Collection<K, V>

concat

Parameters

collections: Collection<K, V>[]

Returns Collection<K, V>

delete

Parameters

key: K

Returns boolean

entries

Returns IterableIterator<[K, V]>

equal

Parameters

collection: Collection<K, V>

Optional options: CollectionEqualOptions

Returns boolean

every

Parameters

predicate: ((value: V, key: K, collection: Collection<K, V>) => boolean)

Parameters

value: V

key: K

collection: Collection<K, V>

Returns boolean

Returns boolean

filter

Type Parameters

T extends [K, V][] = [K, V][]

Parameters

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

Parameters

value: V

key: K

collection: Collection<K, V>

Returns boolean

Optional options: CollectionFilterOptions

Returns [K, V][]

Type Parameters

T extends Collection<any, any, T> = Collection<K, V>

Parameters

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