Skip to main content

Class: Store<T>

The store class which contains Pieces.

Type parameters

NameType
Textends Piece

Hierarchy

Constructors

constructor

โ€ข new Store<T>(constructor, options)

Type parameters

NameType
Textends Piece<PieceOptions, T>

Parameters

NameTypeDescription
constructorConstructor<T>The piece constructor this store loads.
optionsStoreOptions<T>The options for the store.

Overrides

Collection<string, T\>.constructor

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:289

Properties

Constructor

โ€ข Readonly Constructor: Constructor<T>

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:281


[toStringTag]

โ€ข Readonly [toStringTag]: string

Inherited from

Collection.__@toStringTag@324

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:135


constructor

โ€ข constructor: CollectionConstructor

Inherited from

Collection.constructor

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:17


hydrateModuleData

โ€ข Private hydrateModuleData: any

Adds the final module data properties.

param The root directory to add.

param The module data returned from {@link ILoaderStrategy.filter}.

returns The finished module data.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:352


loadPath

โ€ข Private loadPath: any

Loads a directory into the store.

param The directory to load the pieces from.

returns An async iterator that yields the pieces to be loaded into the store.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:358


name

โ€ข Readonly name: string

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:282


paths

โ€ข Readonly paths: Set<string>

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:283


size

โ€ข Readonly size: number

Inherited from

Collection.size

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:28


strategy

โ€ข Readonly strategy: ILoaderStrategy<T>

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:284


walk

โ€ข Private walk: any

Retrieves all possible pieces.

param The directory to load the pieces from.

returns An async iterator that yields the modules to be processed and loaded into the store.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:364


[species]

โ–ช Static Readonly [species]: MapConstructor

Inherited from

Collection.__@species@350

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:317


default

โ–ช Static Readonly default: typeof Collection

Inherited from

Collection.default

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:24


defaultStrategy

โ–ช Static defaultStrategy: ILoaderStrategy<any>

The default strategy, defaults to {@link LoaderStrategy}, which is constructed on demand when a store is constructed, when none was set beforehand.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:369


logger

โ–ช Static logger: null | StoreLogger

The default logger, defaults to null.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:373

Accessors

container

โ€ข get container(): Container

A reference to the {@link Container} object for ease of use.

see container

Returns

Container

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:294

Methods

[iterator]

โ–ธ [iterator](): IterableIterator<[string, T]>

Returns an iterable of entries in the map.

Returns

IterableIterator<[string, T]>

Inherited from

Collection.__@iterator@370

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:121


at

โ–ธ at(index?): undefined | T

Identical to Array.at(). Returns the item at a given index, allowing for positive and negative integers. Negative integers count back from the last item in the collection.

Parameters

NameTypeDescription
index?numberThe index of the element to obtain

Returns

undefined | T

Inherited from

Collection.at

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:87


clear

โ–ธ clear(): void

Returns

void

Inherited from

Collection.clear

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:22


clone

โ–ธ clone(): Collection<string, T>

Creates an identical shallow copy of this collection.

example const newColl = someColl.clone();

Returns

Collection<string, T>

Inherited from

Collection.clone

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:301


concat

โ–ธ concat(...collections): Collection<string, T>

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

NameTypeDescription
...collectionsCollection<string, T>[]Collections to merge

Returns

Collection<string, T>

Inherited from

Collection.concat

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:310


construct

โ–ธ construct(Ctor, data): T

Constructs a Piece instance.

Parameters

NameTypeDescription
CtorILoaderResultEntry<T>The Piece's constructor used to build the instance.
dataHydratedModuleDataThe module's information

Returns

T

An instance of the constructed piece.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:345


delete

โ–ธ delete(key): boolean

Parameters

NameType
keystring

Returns

boolean

Inherited from

Collection.delete

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:23


difference

โ–ธ difference(other): Collection<string, T>

The difference method returns a new structure containing items where the key is present in one of the original structures but not the other.

Parameters

NameTypeDescription
otherCollection<string, T>The other Collection to filter against

Returns

Collection<string, T>

Inherited from

Collection.difference

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:344


each

โ–ธ each(fn): Store<T>

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

NameTypeDescription
fn(value: T, key: string, collection: Store<T>) => voidFunction to execute for each element

Returns

Store<T>

Inherited from

Collection.each

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:279

โ–ธ each<T>(fn, thisArg): Store<T>

Type parameters

Name
T

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => void
thisArgT

Returns

Store<T>

Inherited from

Collection.each

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:280


entries

โ–ธ entries(): IterableIterator<[string, T]>

Returns an iterable of key, value pairs for every entry in the map.

Returns

IterableIterator<[string, T]>

Inherited from

Collection.entries

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:126


equals

โ–ธ equals(collection): boolean

Checks if this collection shares identical items 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

NameTypeDescription
collectionCollection<string, T>Collection to compare with

Returns

boolean

Whether the collections have identical contents

Inherited from

Collection.equals

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:320


every

โ–ธ every<K2>(fn): this is Collection<K2, T>

Checks if all items passes a test. Identical in behavior to Array.every().

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

Type parameters

NameType
K2extends string

Parameters

NameTypeDescription
fn(value: T, key: string, collection: Store<T>) => key is K2Function used to test (should return a boolean)

Returns

this is Collection<K2, T>

Inherited from

Collection.every

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:247

โ–ธ every<V2>(fn): this is Collection<string, V2>

Type parameters

NameType
V2extends Piece<PieceOptions, V2>

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => value is V2

Returns

this is Collection<string, V2>

Inherited from

Collection.every

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:248

โ–ธ every(fn): boolean

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => boolean

Returns

boolean

Inherited from

Collection.every

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:249

โ–ธ every<This, K2>(fn, thisArg): this is Collection<K2, T>

Type parameters

NameType
ThisThis
K2extends string

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => key is K2
thisArgThis

Returns

this is Collection<K2, T>

Inherited from

Collection.every

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:250

โ–ธ every<This, V2>(fn, thisArg): this is Collection<string, V2>

Type parameters

NameType
ThisThis
V2extends Piece<PieceOptions, V2>

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => value is V2
thisArgThis

Returns

this is Collection<string, V2>

Inherited from

Collection.every

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:251

โ–ธ every<This>(fn, thisArg): boolean

Type parameters

Name
This

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => boolean
thisArgThis

Returns

boolean

Inherited from

Collection.every

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:252


filter

โ–ธ filter<K2>(fn): Collection<K2, T>

Identical to Array.filter(), but returns a Collection instead of an Array.

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

Type parameters

NameType
K2extends string

Parameters

NameTypeDescription
fn(value: T, key: string, collection: Store<T>) => key is K2The function to test with (should return boolean)

Returns

Collection<K2, T>

Inherited from

Collection.filter

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:167

โ–ธ filter<V2>(fn): Collection<string, V2>

Type parameters

NameType
V2extends Piece<PieceOptions, V2>

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => value is V2

Returns

Collection<string, V2>

Inherited from

Collection.filter

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:168

โ–ธ filter(fn): Collection<string, T>

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => boolean

Returns

Collection<string, T>

Inherited from

Collection.filter

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:169

โ–ธ filter<This, K2>(fn, thisArg): Collection<K2, T>

Type parameters

NameType
ThisThis
K2extends string

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => key is K2
thisArgThis

Returns

Collection<K2, T>

Inherited from

Collection.filter

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:170

โ–ธ filter<This, V2>(fn, thisArg): Collection<string, V2>

Type parameters

NameType
ThisThis
V2extends Piece<PieceOptions, V2>

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => value is V2
thisArgThis

Returns

Collection<string, V2>

Inherited from

Collection.filter

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:171

โ–ธ filter<This>(fn, thisArg): Collection<string, T>

Type parameters

Name
This

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => boolean
thisArgThis

Returns

Collection<string, T>

Inherited from

Collection.filter

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:172


find

โ–ธ find<V2>(fn): undefined | V2

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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/get) for details.

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

Type parameters

NameType
V2extends Piece<PieceOptions, V2>

Parameters

NameTypeDescription
fn(value: T, key: string, collection: Store<T>) => value is V2The function to test with (should return boolean)

Returns

undefined | V2

Inherited from

Collection.find

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:127

โ–ธ find(fn): undefined | T

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => boolean

Returns

undefined | T

Inherited from

Collection.find

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:128

โ–ธ find<This, V2>(fn, thisArg): undefined | V2

Type parameters

NameType
ThisThis
V2extends Piece<PieceOptions, V2>

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => value is V2
thisArgThis

Returns

undefined | V2

Inherited from

Collection.find

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:129

โ–ธ find<This>(fn, thisArg): undefined | T

Type parameters

Name
This

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => boolean
thisArgThis

Returns

undefined | T

Inherited from

Collection.find

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:130


findKey

โ–ธ findKey<K2>(fn): undefined | K2

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');

Type parameters

NameType
K2extends string

Parameters

NameTypeDescription
fn(value: T, key: string, collection: Store<T>) => key is K2The function to test with (should return boolean)

Returns

undefined | K2

Inherited from

Collection.findKey

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:142

โ–ธ findKey(fn): undefined | string

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => boolean

Returns

undefined | string

Inherited from

Collection.findKey

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:143

โ–ธ findKey<This, K2>(fn, thisArg): undefined | K2

Type parameters

NameType
ThisThis
K2extends string

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => key is K2
thisArgThis

Returns

undefined | K2

Inherited from

Collection.findKey

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:144

โ–ธ findKey<This>(fn, thisArg): undefined | string

Type parameters

Name
This

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => boolean
thisArgThis

Returns

undefined | string

Inherited from

Collection.findKey

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:145


first

โ–ธ first(): undefined | T

Obtains the first value(s) in this collection.

Returns

undefined | T

A single value if no amount is provided or an array of values, starting from the end if amount is negative

Inherited from

Collection.first

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:48

โ–ธ first(amount): T[]

Parameters

NameType
amountnumber

Returns

T[]

Inherited from

Collection.first

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:49


firstKey

โ–ธ firstKey(): undefined | string

Obtains the first key(s) in this collection.

Returns

undefined | string

A single key if no amount is provided or an array of keys, starting from the end if amount is negative

Inherited from

Collection.firstKey

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:58

โ–ธ firstKey(amount): string[]

Parameters

NameType
amountnumber

Returns

string[]

Inherited from

Collection.firstKey

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:59


flatMap

โ–ธ flatMap<T>(fn): Collection<string, T>

Maps each item into a Collection, then joins the results into a single Collection. Identical in behavior to Array.flatMap().

example collection.flatMap(guild => guild.members.cache);

Type parameters

Name
T

Parameters

NameTypeDescription
fn(value: T, key: string, collection: Store<T>) => Collection<string, T>Function that produces a new Collection

Returns

Collection<string, T>

Inherited from

Collection.flatMap

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:199

โ–ธ flatMap<T, This>(fn, thisArg): Collection<string, T>

Type parameters

Name
T
This

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => Collection<string, T>
thisArgThis

Returns

Collection<string, T>

Inherited from

Collection.flatMap

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:200


forEach

โ–ธ forEach(callbackfn, thisArg?): void

Parameters

NameType
callbackfn(value: T, key: string, map: Map<string, T>) => void
thisArg?any

Returns

void

Inherited from

Collection.forEach

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:24


get

โ–ธ get(key): undefined | T

Parameters

NameType
keystring

Returns

undefined | T

Inherited from

Collection.get

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:25


has

โ–ธ has(key): boolean

Parameters

NameType
keystring

Returns

boolean

Inherited from

Collection.has

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:26


hasAll

โ–ธ hasAll(...keys): boolean

Checks if all of the elements exist in the collection.

Parameters

NameTypeDescription
...keysstring[]The keys of the elements to check for

Returns

boolean

true if all of the elements exist, false if at least one does not exist.

Inherited from

Collection.hasAll

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:32


hasAny

โ–ธ hasAny(...keys): boolean

Checks if any of the elements exist in the collection.

Parameters

NameTypeDescription
...keysstring[]The keys of the elements to check for

Returns

boolean

true if any of the elements exist, false if none exist.

Inherited from

Collection.hasAny

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:40


insert

โ–ธ insert(piece): Promise<T>

Inserts a piece into the store.

Parameters

NameTypeDescription
pieceTThe piece to be inserted into the store.

Returns

Promise<T>

The inserted piece.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:338


intersect

โ–ธ intersect(other): Collection<string, T>

The intersect method returns a new structure containing items where the keys are present in both original structures.

Parameters

NameTypeDescription
otherCollection<string, T>The other Collection to filter against

Returns

Collection<string, T>

Inherited from

Collection.intersect

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:338


keyAt

โ–ธ keyAt(index?): undefined | string

Identical to Array.at(). Returns the key at a given index, allowing for positive and negative integers. Negative integers count back from the last item in the collection.

Parameters

NameTypeDescription
index?numberThe index of the key to obtain

Returns

undefined | string

Inherited from

Collection.keyAt

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:95


keys

โ–ธ keys(): IterableIterator<string>

Returns an iterable of keys in the map

Returns

IterableIterator<string>

Inherited from

Collection.keys

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:131


last

โ–ธ last(): undefined | T

Obtains the last value(s) in this collection.

Returns

undefined | T

A single value if no amount is provided or an array of values, starting from the start if amount is negative

Inherited from

Collection.last

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:68

โ–ธ last(amount): T[]

Parameters

NameType
amountnumber

Returns

T[]

Inherited from

Collection.last

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:69


lastKey

โ–ธ lastKey(): undefined | string

Obtains the last key(s) in this collection.

Returns

undefined | string

A single key if no amount is provided or an array of keys, starting from the start if amount is negative

Inherited from

Collection.lastKey

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:78

โ–ธ lastKey(amount): string[]

Parameters

NameType
amountnumber

Returns

string[]

Inherited from

Collection.lastKey

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:79


load

โ–ธ load(root, path): Promise<T[]>

Loads one or more pieces from a path.

Parameters

NameTypeDescription
rootstringThe root directory the file is from.
pathstringThe path of the file to load, relative to the root.

Returns

Promise<T[]>

All the loaded pieces.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:312


loadAll

โ–ธ loadAll(): Promise<void>

Loads all pieces from all directories specified by paths.

Returns

Promise<void>

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:326


map

โ–ธ map<T>(fn): T[]

Maps each item to another value into an array. Identical in behavior to Array.map().

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

Type parameters

Name
T

Parameters

NameTypeDescription
fn(value: T, key: string, collection: Store<T>) => TFunction that produces an element of the new array, taking three arguments

Returns

T[]

Inherited from

Collection.map

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:211

โ–ธ map<This, T>(fn, thisArg): T[]

Type parameters

Name
This
T

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => T
thisArgThis

Returns

T[]

Inherited from

Collection.map

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:212


mapValues

โ–ธ mapValues<T>(fn): Collection<string, T>

Maps each item to another value into a collection. Identical in behavior to Array.map().

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

Type parameters

Name
T

Parameters

NameTypeDescription
fn(value: T, key: string, collection: Store<T>) => TFunction that produces an element of the new collection, taking three arguments

Returns

Collection<string, T>

Inherited from

Collection.mapValues

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:223

โ–ธ mapValues<This, T>(fn, thisArg): Collection<string, T>

Type parameters

Name
This
T

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => T
thisArgThis

Returns

Collection<string, T>

Inherited from

Collection.mapValues

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:224


partition

โ–ธ partition<K2>(fn): [Collection<K2, T>, Collection<Exclude<string, K2>, T>]

Partitions the collection into two collections where the first collection contains the items that passed and the second contains the items that failed.

example const [big, small] = collection.partition(guild => guild.memberCount > 250);

Type parameters

NameType
K2extends string

Parameters

NameTypeDescription
fn(value: T, key: string, collection: Store<T>) => key is K2Function used to test (should return a boolean)

Returns

[Collection<K2, T>, Collection<Exclude<string, K2>, T>]

Inherited from

Collection.partition

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:183

โ–ธ partition<V2>(fn): [Collection<string, V2>, Collection<string, Exclude<T, V2>>]

Type parameters

NameType
V2extends Piece<PieceOptions, V2>

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => value is V2

Returns

[Collection<string, V2>, Collection<string, Exclude<T, V2>>]

Inherited from

Collection.partition

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:184

โ–ธ partition(fn): [Collection<string, T>, Collection<string, T>]

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => boolean

Returns

[Collection<string, T>, Collection<string, T>]

Inherited from

Collection.partition

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:185

โ–ธ partition<This, K2>(fn, thisArg): [Collection<K2, T>, Collection<Exclude<string, K2>, T>]

Type parameters

NameType
ThisThis
K2extends string

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => key is K2
thisArgThis

Returns

[Collection<K2, T>, Collection<Exclude<string, K2>, T>]

Inherited from

Collection.partition

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:186

โ–ธ partition<This, V2>(fn, thisArg): [Collection<string, V2>, Collection<string, Exclude<T, V2>>]

Type parameters

NameType
ThisThis
V2extends Piece<PieceOptions, V2>

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => value is V2
thisArgThis

Returns

[Collection<string, V2>, Collection<string, Exclude<T, V2>>]

Inherited from

Collection.partition

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:187

โ–ธ partition<This>(fn, thisArg): [Collection<string, T>, Collection<string, T>]

Type parameters

Name
This

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => boolean
thisArgThis

Returns

[Collection<string, T>, Collection<string, T>]

Inherited from

Collection.partition

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:188


random

โ–ธ random(): undefined | T

Obtains unique random value(s) from this collection.

Returns

undefined | T

A single value if no amount is provided or an array of values

Inherited from

Collection.random

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:103

โ–ธ random(amount): T[]

Parameters

NameType
amountnumber

Returns

T[]

Inherited from

Collection.random

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:104


randomKey

โ–ธ randomKey(): undefined | string

Obtains unique random key(s) from this collection.

Returns

undefined | string

A single key if no amount is provided or an array

Inherited from

Collection.randomKey

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:112

โ–ธ randomKey(amount): string[]

Parameters

NameType
amountnumber

Returns

string[]

Inherited from

Collection.randomKey

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:113


reduce

โ–ธ reduce<T>(fn, initialValue?): T

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

Name
T

Parameters

NameTypeDescription
fn(accumulator: T, value: T, key: string, collection: Store<T>) => TFunction used to reduce, taking four arguments; accumulator, currentValue, currentKey, and collection
initialValue?TStarting value for the accumulator

Returns

T

Inherited from

Collection.reduce

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:264


registerPath

โ–ธ registerPath(path): Store<T>

Registers a directory into the store.

example

store
.registerPath(resolve('commands'))
.registerPath(resolve('third-party', 'commands'));

Parameters

NameTypeDescription
pathstringThe path to be added.

Returns

Store<T>

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:305


resolve

โ–ธ resolve(name): T

Resolves a piece by its name or its instance.

Parameters

NameTypeDescription
namestring | TThe name of the piece or the instance itself.

Returns

T

The resolved piece.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:332


set

โ–ธ set(key, value): Store<T>

Parameters

NameType
keystring
valueT

Returns

Store<T>

Inherited from

Collection.set

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:27


some

โ–ธ some(fn): boolean

Checks if there exists an item that passes a test. Identical in behavior to Array.some().

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

Parameters

NameTypeDescription
fn(value: T, key: string, collection: Store<T>) => booleanFunction used to test (should return a boolean)

Returns

boolean

Inherited from

Collection.some

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:235

โ–ธ some<T>(fn, thisArg): boolean

Type parameters

Name
T

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => boolean
thisArgT

Returns

boolean

Inherited from

Collection.some

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:236


sort

โ–ธ sort(compareFunction?): Store<T>

The sort method sorts the items of a collection in place and returns it. The sort is not necessarily stable in Node 10 or older. The default sort order is according to string Unicode code points.

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

Parameters

NameTypeDescription
compareFunction?Comparator<string, T>Specifies a function that defines the sort order. If omitted, the collection is sorted according to each character's Unicode code point value, according to the string conversion of each element.

Returns

Store<T>

Inherited from

Collection.sort

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:332


sorted

โ–ธ sorted(compareFunction?): Collection<string, T>

The sorted method sorts the items of a collection and returns it. The sort is not necessarily stable in Node 10 or older. The default sort order is according to string Unicode code points.

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

Parameters

NameTypeDescription
compareFunction?Comparator<string, T>Specifies a function that defines the sort order. If omitted, the collection is sorted according to each character's Unicode code point value, according to the string conversion of each element.

Returns

Collection<string, T>

Inherited from

Collection.sorted

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:357


sweep

โ–ธ sweep(fn): number

Removes items that satisfy the provided filter function.

Parameters

NameTypeDescription
fn(value: T, key: string, collection: Store<T>) => booleanFunction used to test (should return a boolean)

Returns

number

The number of removed entries

Inherited from

Collection.sweep

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:154

โ–ธ sweep<T>(fn, thisArg): number

Type parameters

Name
T

Parameters

NameType
fn(value: T, key: string, collection: Store<T>) => boolean
thisArgT

Returns

number

Inherited from

Collection.sweep

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:155


tap

โ–ธ tap(fn): Store<T>

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

NameTypeDescription
fn(collection: Store<T>) => voidFunction to execute

Returns

Store<T>

Inherited from

Collection.tap

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:293

โ–ธ tap<T>(fn, thisArg): Store<T>

Type parameters

Name
T

Parameters

NameType
fn(collection: Store<T>) => void
thisArgT

Returns

Store<T>

Inherited from

Collection.tap

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:294


toJSON

โ–ธ toJSON(): T[]

Returns

T[]

Inherited from

Collection.toJSON

Defined in

node_modules/@discordjs/collection/dist/index.d.ts:358


unload

โ–ธ unload(name): Promise<T>

Unloads a piece given its instance or its name.

Parameters

NameTypeDescription
namestring | TThe name of the file to load.

Returns

Promise<T>

Returns the piece that was unloaded.

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:318


unloadAll

โ–ธ unloadAll(): Promise<T[]>

Unloads all pieces from the store.

Returns

Promise<T[]>

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:322


values

โ–ธ values(): IterableIterator<T>

Returns an iterable of values in the map

Returns

IterableIterator<T>

Inherited from

Collection.values

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:136