Class: CommandStore

Stores all Command pieces

Since

1.0.0

Hierarchy

• AliasStore<Command, "commands">

  ↳ CommandStore

Constructors

constructor

• new CommandStore(): CommandStore

Returns

CommandStore

Overrides

AliasStore.constructor

Defined in

projects/framework/src/lib/structures/CommandStore.ts:19

Properties

#private

• Private #private: any

Inherited from

AliasStore.#private

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:461

---

Constructor

• Readonly Constructor: AbstractConstructor<Command<Args, CommandOptions>>

Inherited from

AliasStore.Constructor

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:462

---

[toStringTag]

• Readonly [toStringTag]: string

Inherited from

AliasStore.[toStringTag]

Defined in

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

---

aliases

• Readonly aliases: Collection<string, Command<Args, CommandOptions>>

The aliases referencing to pieces.

Inherited from

AliasStore.aliases

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:901

---

constructor

• constructor: CollectionConstructor

Inherited from

AliasStore.constructor

Defined in

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

---

name

• Readonly name: "commands"

Inherited from

AliasStore.name

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:463

---

paths

• Readonly paths: Set<string>

Inherited from

AliasStore.paths

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:464

---

size

• Readonly size: number

Inherited from

AliasStore.size

Defined in

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

---

strategy

• Readonly strategy: ILoaderStrategy<Command<Args, CommandOptions>>

Inherited from

AliasStore.strategy

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:465

---

[species]

▪ Static Readonly [species]: MapConstructor

Inherited from

AliasStore.[species]

Defined in

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

---

defaultStrategy

▪ Static defaultStrategy: ILoaderStrategy<any>

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

Inherited from

AliasStore.defaultStrategy

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:584

---

logger

▪ Static logger: null | StoreLogger

The default logger, defaults to null.

Inherited from

AliasStore.logger

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:588

Accessors

categories

• get categories(): string[]

Get all the command categories.

Returns

string[]

Defined in

projects/framework/src/lib/structures/CommandStore.ts:26

---

container

• get container(): Container

A reference to the Container object for ease of use.

Returns

Container

See

container

Inherited from

AliasStore.container

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:479

Methods

[iterator]

▸ [iterator](): IterableIterator<[string, Command<Args, CommandOptions>]>

Returns an iterable of entries in the map.

Returns

IterableIterator<[string, Command<Args, CommandOptions>]>

Inherited from

AliasStore.[iterator]

Defined in

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

---

at

▸ at(index): undefined | Command<Args, CommandOptions>

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

Name	Type	Description
index	number	The index of the element to obtain

Returns

undefined | Command<Args, CommandOptions>

Inherited from

AliasStore.at

Defined in

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

---

clear

▸ clear(): void

Returns

void

Inherited from

AliasStore.clear

Defined in

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

---

clone

▸ clone(): Collection<string, Command<Args, CommandOptions>>

Creates an identical shallow copy of this collection.

Returns

Collection<string, Command<Args, CommandOptions>>

Example

const newColl = someColl.clone();

Inherited from

AliasStore.clone

Defined in

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

---

concat

▸ concat(...collections): Collection<string, Command<Args, CommandOptions>>

Combines this collection with others into a new collection. None of the source collections are modified.

Parameters

Name	Type	Description
...collections	ReadonlyCollection<string, Command<Args, CommandOptions>>[]	Collections to merge

Returns

Collection<string, Command<Args, CommandOptions>>

Example

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

Inherited from

AliasStore.concat

Defined in

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

---

construct

▸ construct(Ctor, data): Command<Args, CommandOptions>

Constructs a Piece instance.

Parameters

Name	Type	Description
Ctor	ILoaderResultEntry<Command<Args, CommandOptions>>	The Piece's constructor used to build the instance.
data	HydratedModuleData	The module's information

Returns

Command<Args, CommandOptions>

An instance of the constructed piece.

Inherited from

AliasStore.construct

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:566

---

delete

▸ delete(key): boolean

Parameters

Name	Type
key	string

Returns

boolean

true if an element in the Map existed and has been removed, or false if the element does not exist.

Inherited from

AliasStore.delete

Defined in

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

---

difference

▸ difference<T>(other): Collection<string, Command<Args, CommandOptions> | 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.

Type parameters

Name
T

Parameters

Name	Type	Description
other	ReadonlyCollection<string, T>	The other Collection to filter against

Returns

Collection<string, Command<Args, CommandOptions> | T>

Inherited from

AliasStore.difference

Defined in

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

---

each

▸ each(fn): this

Identical to Map.forEach(), but returns the collection instead of undefined.

Parameters

Name	Type	Description
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => void	Function to execute for each element

Returns

this

Example

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

Inherited from

AliasStore.each

Defined in

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

▸ each<T>(fn, thisArg): this

Type parameters

Name
T

Parameters

Name	Type
fn	(this: T, value: Command<Args, CommandOptions>, key: string, collection: this) => void
thisArg	T

Returns

this

Inherited from

AliasStore.each

Defined in

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

---

ensure

▸ ensure(key, defaultValueGenerator): Command<Args, CommandOptions>

Obtains the value of the given key if it exists, otherwise sets and returns the value provided by the default value generator.

Parameters

Name	Type	Description
key	string	The key to get if it exists, or set otherwise
defaultValueGenerator	(key: string, collection: this) => Command<Args, CommandOptions>	A function that generates the default value

Returns

Command<Args, CommandOptions>

Example

collection.ensure(guildId, () => defaultGuildConfig);

Inherited from

AliasStore.ensure

Defined in

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

---

entries

▸ entries(): IterableIterator<[string, Command<Args, CommandOptions>]>

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

Returns

IterableIterator<[string, Command<Args, CommandOptions>]>

Inherited from

AliasStore.entries

Defined in

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

---

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

Name	Type	Description
collection	ReadonlyCollection<string, Command<Args, CommandOptions>>	Collection to compare with

Returns

boolean

Whether the collections have identical contents

Inherited from

AliasStore.equals

Defined in

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

---

every

▸ every<K2>(fn): this is Collection<K2, Command<Args, CommandOptions>>

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

Type parameters

Name	Type
K2	extends string

Parameters

Name	Type	Description
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => key is K2	Function used to test (should return a boolean)

Returns

this is Collection<K2, Command<Args, CommandOptions>>

Example

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

Inherited from

AliasStore.every

Defined in

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

▸ every<V2>(fn): this is Collection<string, V2>

Type parameters

Name	Type
V2	extends Command<Args, CommandOptions>

Parameters

Name	Type
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => value is V2

Returns

this is Collection<string, V2>

Inherited from

AliasStore.every

Defined in

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

▸ every(fn): boolean

Parameters

Name	Type
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => unknown

Returns

boolean

Inherited from

AliasStore.every

Defined in

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

▸ every<This, K2>(fn, thisArg): this is Collection<K2, Command<Args, CommandOptions>>

Type parameters

Name	Type
This	This
K2	extends string

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => key is K2
thisArg	This

Returns

this is Collection<K2, Command<Args, CommandOptions>>

Inherited from

AliasStore.every

Defined in

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

▸ every<This, V2>(fn, thisArg): this is Collection<string, V2>

Type parameters

Name	Type
This	This
V2	extends Command<Args, CommandOptions>

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => value is V2
thisArg	This

Returns

this is Collection<string, V2>

Inherited from

AliasStore.every

Defined in

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

▸ every<This>(fn, thisArg): boolean

Type parameters

Name
This

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => unknown
thisArg	This

Returns

boolean

Inherited from

AliasStore.every

Defined in

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

---

filter

▸ filter<K2>(fn): Collection<K2, Command<Args, CommandOptions>>

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

Type parameters

Name	Type
K2	extends string

Parameters

Name	Type	Description
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => key is K2	The function to test with (should return boolean)

Returns

Collection<K2, Command<Args, CommandOptions>>

Example

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

Inherited from

AliasStore.filter

Defined in

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

▸ filter<V2>(fn): Collection<string, V2>

Type parameters

Name	Type
V2	extends Command<Args, CommandOptions>

Parameters

Name	Type
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => value is V2

Returns

Collection<string, V2>

Inherited from

AliasStore.filter

Defined in

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

▸ filter(fn): Collection<string, Command<Args, CommandOptions>>

Parameters

Name	Type
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => unknown

Returns

Collection<string, Command<Args, CommandOptions>>

Inherited from

AliasStore.filter

Defined in

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

▸ filter<This, K2>(fn, thisArg): Collection<K2, Command<Args, CommandOptions>>

Type parameters

Name	Type
This	This
K2	extends string

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => key is K2
thisArg	This

Returns

Collection<K2, Command<Args, CommandOptions>>

Inherited from

AliasStore.filter

Defined in

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

▸ filter<This, V2>(fn, thisArg): Collection<string, V2>

Type parameters

Name	Type
This	This
V2	extends Command<Args, CommandOptions>

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => value is V2
thisArg	This

Returns

Collection<string, V2>

Inherited from

AliasStore.filter

Defined in

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

▸ filter<This>(fn, thisArg): Collection<string, Command<Args, CommandOptions>>

Type parameters

Name
This

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => unknown
thisArg	This

Returns

Collection<string, Command<Args, CommandOptions>>

Inherited from

AliasStore.filter

Defined in

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

---

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 for details.

Type parameters

Name	Type
V2	extends Command<Args, CommandOptions>

Parameters

Name	Type	Description
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => value is V2	The function to test with (should return boolean)

Returns

undefined | V2

Example

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

Inherited from

AliasStore.find

Defined in

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

▸ find(fn): undefined | Command<Args, CommandOptions>

Parameters

Name	Type
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => unknown

Returns

undefined | Command<Args, CommandOptions>

Inherited from

AliasStore.find

Defined in

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

▸ find<This, V2>(fn, thisArg): undefined | V2

Type parameters

Name	Type
This	This
V2	extends Command<Args, CommandOptions>

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => value is V2
thisArg	This

Returns

undefined | V2

Inherited from

AliasStore.find

Defined in

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

▸ find<This>(fn, thisArg): undefined | Command<Args, CommandOptions>

Type parameters

Name
This

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => unknown
thisArg	This

Returns

undefined | Command<Args, CommandOptions>

Inherited from

AliasStore.find

Defined in

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

---

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.

Type parameters

Name	Type
K2	extends string

Parameters

Name	Type	Description
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => key is K2	The function to test with (should return boolean)

Returns

undefined | K2

Example

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

Inherited from

AliasStore.findKey

Defined in

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

▸ findKey(fn): undefined | string

Parameters

Name	Type
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => unknown

Returns

undefined | string

Inherited from

AliasStore.findKey

Defined in

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

▸ findKey<This, K2>(fn, thisArg): undefined | K2

Type parameters

Name	Type
This	This
K2	extends string

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => key is K2
thisArg	This

Returns

undefined | K2

Inherited from

AliasStore.findKey

Defined in

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

▸ findKey<This>(fn, thisArg): undefined | string

Type parameters

Name
This

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => unknown
thisArg	This

Returns

undefined | string

Inherited from

AliasStore.findKey

Defined in

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

---

first

▸ first(): undefined | Command<Args, CommandOptions>

Obtains the first value(s) in this collection.

Returns

undefined | Command<Args, CommandOptions>

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

Inherited from

AliasStore.first

Defined in

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

▸ first(amount): Command<Args, CommandOptions>[]

Parameters

Name	Type
amount	number

Returns

Command<Args, CommandOptions>[]

Inherited from

AliasStore.first

Defined in

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

---

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

AliasStore.firstKey

Defined in

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

▸ firstKey(amount): string[]

Parameters

Name	Type
amount	number

Returns

string[]

Inherited from

AliasStore.firstKey

Defined in

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

---

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().

Type parameters

Name
T

Parameters

Name	Type	Description
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => Collection<string, T>	Function that produces a new Collection

Returns

Collection<string, T>

Example

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

Inherited from

AliasStore.flatMap

Defined in

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

▸ flatMap<T, This>(fn, thisArg): Collection<string, T>

Type parameters

Name
T
This

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => Collection<string, T>
thisArg	This

Returns

Collection<string, T>

Inherited from

AliasStore.flatMap

Defined in

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

---

forEach

▸ forEach(callbackfn, thisArg?): void

Executes a provided function once per each key/value pair in the Map, in insertion order.

Parameters

Name	Type
callbackfn	(value: Command<Args, CommandOptions>, key: string, map: Map<string, Command<Args, CommandOptions>>) => void
thisArg?	any

Returns

void

Inherited from

AliasStore.forEach

Defined in

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

---

get

▸ get(key): undefined | Command<Args, CommandOptions>

Looks up the name by the store, falling back to an alias lookup.

Parameters

Name	Type	Description
key	string	The key to look for.

Returns

undefined | Command<Args, CommandOptions>

Inherited from

AliasStore.get

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:906

---

has

▸ has(key): boolean

Checks whether a key is in the store, or is an alias

Parameters

Name	Type	Description
key	string	The key to check

Returns

boolean

Inherited from

AliasStore.has

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:911

---

hasAll

▸ hasAll(...keys): boolean

Checks if all of the elements exist in the collection.

Parameters

Name	Type	Description
...keys	string[]	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

AliasStore.hasAll

Defined in

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

---

hasAny

▸ hasAny(...keys): boolean

Checks if any of the elements exist in the collection.

Parameters

Name	Type	Description
...keys	string[]	The keys of the elements to check for

Returns

boolean

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

Inherited from

AliasStore.hasAny

Defined in

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

---

insert

▸ insert(piece): Promise<Command<Args, CommandOptions>>

Inserts a piece into the store, and adds all the aliases.

Parameters

Name	Type	Description
piece	Command<Args, CommandOptions>	The piece to be inserted into the store.

Returns

Promise<Command<Args, CommandOptions>>

The inserted piece.

Inherited from

AliasStore.insert

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:923

---

intersect

▸ intersect<T>(other): Collection<string, T>

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

Type parameters

Name
T

Parameters

Name	Type	Description
other	ReadonlyCollection<string, T>	The other Collection to filter against

Returns

Collection<string, T>

Inherited from

AliasStore.intersect

Defined in

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

---

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

Name	Type	Description
index	number	The index of the key to obtain

Returns

undefined | string

Inherited from

AliasStore.keyAt

Defined in

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

---

keys

▸ keys(): IterableIterator<string>

Returns an iterable of keys in the map

Returns

IterableIterator<string>

Inherited from

AliasStore.keys

Defined in

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

---

last

▸ last(): undefined | Command<Args, CommandOptions>

Obtains the last value(s) in this collection.

Returns

undefined | Command<Args, CommandOptions>

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

Inherited from

AliasStore.last

Defined in

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

▸ last(amount): Command<Args, CommandOptions>[]

Parameters

Name	Type
amount	number

Returns

Command<Args, CommandOptions>[]

Inherited from

AliasStore.last

Defined in

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

---

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

AliasStore.lastKey

Defined in

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

▸ lastKey(amount): string[]

Parameters

Name	Type
amount	number

Returns

string[]

Inherited from

AliasStore.lastKey

Defined in

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

---

load

▸ load(root, path): Promise<Command<Args, CommandOptions>[]>

Loads one or more pieces from a path.

Parameters

Name	Type	Description
root	string	The root directory the file is from.
path	string	The path of the file to load, relative to the root.

Returns

Promise<Command<Args, CommandOptions>[]>

All the loaded pieces.

Inherited from

AliasStore.load

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:533

---

loadAll

▸ loadAll(): Promise<void>

Loads all pieces from all directories specified by paths.

Returns

Promise<void>

Overrides

AliasStore.loadAll

Defined in

projects/framework/src/lib/structures/CommandStore.ts:56

---

loadPiece

▸ loadPiece(entry): Promise<void>

Adds a piece into the store's list of manually registered pieces. If () was called, the piece will be loaded immediately, otherwise it will be queued until () is called.

All manually registered pieces will be kept even after they are loaded to ensure they can be loaded again if () is called again.

Parameters

Name	Type	Description
entry	StoreManuallyRegisteredPiece<"commands">	The entry to load.

Returns

Promise<void>

Remarks

• Pieces loaded this way will have their root and path set to VirtualPath, and as such, cannot be reloaded.
• This method is useful in environments where file system access is limited or unavailable, such as when using Serverless Computing.
• This method will always throw a TypeError if entry.piece is not a class.
• This method will always throw a LoaderError if the piece does not extend the store's piece constructor.
• This operation is atomic, if any of the above errors are thrown, the piece will not be loaded.

Seealso

()

Since

3.8.0

Example

import { container } from '@sapphire/pieces';

class PingCommand extends Command {
  // ...
}

container.stores.get('commands').loadPiece({
  name: 'ping',
  piece: PingCommand
});

Inherited from

AliasStore.loadPiece

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:526

---

map

▸ map<T>(fn): T[]

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

Type parameters

Name
T

Parameters

Name	Type	Description
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => T	Function that produces an element of the new array, taking three arguments

Returns

T[]

Example

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

Inherited from

AliasStore.map

Defined in

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

▸ map<This, T>(fn, thisArg): T[]

Type parameters

Name
This
T

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => T
thisArg	This

Returns

T[]

Inherited from

AliasStore.map

Defined in

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

---

mapValues

▸ mapValues<T>(fn): Collection<string, T>

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

Type parameters

Name
T

Parameters

Name	Type	Description
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => T	Function that produces an element of the new collection, taking three arguments

Returns

Collection<string, T>

Example

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

Inherited from

AliasStore.mapValues

Defined in

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

▸ mapValues<This, T>(fn, thisArg): Collection<string, T>

Type parameters

Name
This
T

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => T
thisArg	This

Returns

Collection<string, T>

Inherited from

AliasStore.mapValues

Defined in

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

---

merge

▸ merge<T, R>(other, whenInSelf, whenInOther, whenInBoth): Collection<string, R>

Merges two Collections together into a new Collection.

Type parameters

Name
T
R

Parameters

Name	Type	Description
other	ReadonlyCollection<string, T>	The other Collection to merge with
whenInSelf	(value: Command<Args, CommandOptions>, key: string) => Keep<R>	Function getting the result if the entry only exists in this Collection
whenInOther	(valueOther: T, key: string) => Keep<R>	Function getting the result if the entry only exists in the other Collection
whenInBoth	(value: Command<Args, CommandOptions>, valueOther: T, key: string) => Keep<R>	Function getting the result if the entry exists in both Collections

Returns

Collection<string, R>

Example

// Sums up the entries in two collections.
coll.merge(
 other,
 x => ({ keep: true, value: x }),
 y => ({ keep: true, value: y }),
 (x, y) => ({ keep: true, value: x + y }),
);

Example

// Intersects two collections in a left-biased manner.
coll.merge(
 other,
 x => ({ keep: false }),
 y => ({ keep: false }),
 (x, _) => ({ keep: true, value: x }),
);

Inherited from

AliasStore.merge

Defined in

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

---

partition

▸ partition<K2>(fn): [Collection<K2, Command<Args, CommandOptions>>, Collection<Exclude<string, K2>, Command<Args, CommandOptions>>]

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

Type parameters

Name	Type
K2	extends string

Parameters

Name	Type	Description
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => key is K2	Function used to test (should return a boolean)

Returns

[Collection<K2, Command<Args, CommandOptions>>, Collection<Exclude<string, K2>, Command<Args, CommandOptions>>]

Example

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

Inherited from

AliasStore.partition

Defined in

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

▸ partition<V2>(fn): [Collection<string, V2>, Collection<string, Exclude<Command<Args, CommandOptions>, V2>>]

Type parameters

Name	Type
V2	extends Command<Args, CommandOptions>

Parameters

Name	Type
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => value is V2

Returns

[Collection<string, V2>, Collection<string, Exclude<Command<Args, CommandOptions>, V2>>]

Inherited from

AliasStore.partition

Defined in

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

▸ partition(fn): [Collection<string, Command<Args, CommandOptions>>, Collection<string, Command<Args, CommandOptions>>]

Parameters

Name	Type
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => unknown

Returns

[Collection<string, Command<Args, CommandOptions>>, Collection<string, Command<Args, CommandOptions>>]

Inherited from

AliasStore.partition

Defined in

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

▸ partition<This, K2>(fn, thisArg): [Collection<K2, Command<Args, CommandOptions>>, Collection<Exclude<string, K2>, Command<Args, CommandOptions>>]

Type parameters

Name	Type
This	This
K2	extends string

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => key is K2
thisArg	This

Returns

[Collection<K2, Command<Args, CommandOptions>>, Collection<Exclude<string, K2>, Command<Args, CommandOptions>>]

Inherited from

AliasStore.partition

Defined in

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

▸ partition<This, V2>(fn, thisArg): [Collection<string, V2>, Collection<string, Exclude<Command<Args, CommandOptions>, V2>>]

Type parameters

Name	Type
This	This
V2	extends Command<Args, CommandOptions>

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => value is V2
thisArg	This

Returns

[Collection<string, V2>, Collection<string, Exclude<Command<Args, CommandOptions>, V2>>]

Inherited from

AliasStore.partition

Defined in

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

▸ partition<This>(fn, thisArg): [Collection<string, Command<Args, CommandOptions>>, Collection<string, Command<Args, CommandOptions>>]

Type parameters

Name
This

Parameters

Name	Type
fn	(this: This, value: Command<Args, CommandOptions>, key: string, collection: this) => unknown
thisArg	This

Returns

[Collection<string, Command<Args, CommandOptions>>, Collection<string, Command<Args, CommandOptions>>]

Inherited from

AliasStore.partition

Defined in

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

---

random

▸ random(): undefined | Command<Args, CommandOptions>

Obtains unique random value(s) from this collection.

Returns

undefined | Command<Args, CommandOptions>

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

Inherited from

AliasStore.random

Defined in

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

▸ random(amount): Command<Args, CommandOptions>[]

Parameters

Name	Type
amount	number

Returns

Command<Args, CommandOptions>[]

Inherited from

AliasStore.random

Defined in

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

---

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

AliasStore.randomKey

Defined in

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

▸ randomKey(amount): string[]

Parameters

Name	Type
amount	number

Returns

string[]

Inherited from

AliasStore.randomKey

Defined in

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

---

reduce

▸ reduce<T>(fn, initialValue?): T

Applies a function to produce a single value. Identical in behavior to Array.reduce().

Type parameters

Name	Type
T	Command<Args, CommandOptions>

Parameters

Name	Type	Description
fn	(accumulator: T, value: Command<Args, CommandOptions>, key: string, collection: this) => T	Function used to reduce, taking four arguments; accumulator, currentValue, currentKey, and collection
initialValue?	T	Starting value for the accumulator

Returns

T

Example

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

Inherited from

AliasStore.reduce

Defined in

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

---

registerPath

▸ registerPath(path): this

Registers a directory into the store.

Parameters

Name	Type	Description
path	Path	The path to be added.

Returns

this

Example

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

Inherited from

AliasStore.registerPath

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:490

---

resolve

▸ resolve(name): Command<Args, CommandOptions>

Resolves a piece by its name or its instance.

Parameters

Name	Type	Description
name	string | Command<Args, CommandOptions>	The name of the piece or the instance itself.

Returns

Command<Args, CommandOptions>

The resolved piece.

Inherited from

AliasStore.resolve

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:553

---

reverse

▸ reverse(): this

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

Returns

this

Inherited from

AliasStore.reverse

Defined in

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

---

set

▸ set(key, value): this

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.

Parameters

Name	Type
key	string
value	Command<Args, CommandOptions>

Returns

this

Inherited from

AliasStore.set

Defined in

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

---

some

▸ some(fn): boolean

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

Parameters

Name	Type	Description
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => unknown	Function used to test (should return a boolean)

Returns

boolean

Example

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

Inherited from

AliasStore.some

Defined in

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

▸ some<T>(fn, thisArg): boolean

Type parameters

Name
T

Parameters

Name	Type
fn	(this: T, value: Command<Args, CommandOptions>, key: string, collection: this) => unknown
thisArg	T

Returns

boolean

Inherited from

AliasStore.some

Defined in

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

---

sort

▸ sort(compareFunction?): this

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.

Parameters

Name	Type	Description
compareFunction?	Comparator<string, Command<Args, CommandOptions>>	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

this

Example

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

Inherited from

AliasStore.sort

Defined in

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

---

sorted

▸ sorted(compareFunction?): Collection<string, Command<Args, CommandOptions>>

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.

Parameters

Name	Type	Description
compareFunction?	Comparator<string, Command<Args, CommandOptions>>	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, Command<Args, CommandOptions>>

Example

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

Inherited from

AliasStore.sorted

Defined in

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

---

subtract

▸ subtract<T>(other): Collection<string, Command<Args, CommandOptions>>

The subtract method returns a new structure containing items where the keys and values of the original structure are not present in the other.

Type parameters

Name
T

Parameters

Name	Type	Description
other	ReadonlyCollection<string, T>	The other Collection to filter against

Returns

Collection<string, Command<Args, CommandOptions>>

Inherited from

AliasStore.subtract

Defined in

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

---

sweep

▸ sweep(fn): number

Removes items that satisfy the provided filter function.

Parameters

Name	Type	Description
fn	(value: Command<Args, CommandOptions>, key: string, collection: this) => unknown	Function used to test (should return a boolean)

Returns

number

The number of removed entries

Inherited from

AliasStore.sweep

Defined in

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

▸ sweep<T>(fn, thisArg): number

Type parameters

Name
T

Parameters

Name	Type
fn	(this: T, value: Command<Args, CommandOptions>, key: string, collection: this) => unknown
thisArg	T

Returns

number

Inherited from

AliasStore.sweep

Defined in

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

---

tap

▸ tap(fn): this

Runs a function on the collection and returns the collection.

Parameters

Name	Type	Description
fn	(collection: this) => void	Function to execute

Returns

this

Example

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

Inherited from

AliasStore.tap

Defined in

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

▸ tap<T>(fn, thisArg): this

Type parameters

Name
T

Parameters

Name	Type
fn	(this: T, collection: this) => void
thisArg	T

Returns

this

Inherited from

AliasStore.tap

Defined in

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

---

toJSON

▸ toJSON(): Command<Args, CommandOptions>[]

Returns

Command<Args, CommandOptions>[]

Inherited from

AliasStore.toJSON

Defined in

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

---

unload

▸ unload(name): Promise<Command<Args, CommandOptions>>

Unloads a piece given its instance or its name, and removes all the aliases.

Parameters

Name	Type	Description
name	string | Command<Args, CommandOptions>	The name of the file to load.

Returns

Promise<Command<Args, CommandOptions>>

Returns the piece that was unloaded.

Overrides

AliasStore.unload

Defined in

projects/framework/src/lib/structures/CommandStore.ts:32

---

unloadAll

▸ unloadAll(): Promise<Command<Args, CommandOptions>[]>

Unloads all pieces from the store.

Returns

Promise<Command<Args, CommandOptions>[]>

Inherited from

AliasStore.unloadAll

Defined in

node_modules/@sapphire/pieces/dist/esm/index.d.mts:543

---

values

▸ values(): IterableIterator<Command<Args, CommandOptions>>

Returns an iterable of values in the map

Returns

IterableIterator<Command<Args, CommandOptions>>

Inherited from

AliasStore.values

Defined in

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

---

combineEntries

▸ combineEntries<K, V>(entries, combine): Collection<K, V>

Creates a Collection from a list of entries.

Type parameters

Name
K
V

Parameters

Name	Type	Description
entries	Iterable<[K, V]>	The list of entries
combine	(firstValue: V, secondValue: V, key: K) => V	Function to combine an existing entry with a new one

Returns

Collection<K, V>

Example

Collection.combineEntries([["a", 1], ["b", 2], ["a", 2]], (x, y) => x + y);
// returns Collection { "a" => 3, "b" => 2 }

Inherited from

AliasStore.combineEntries

Defined in

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

---

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

Name
K
T

Parameters

Name	Type	Description
items	Iterable<T>	An iterable.
keySelector	(item: T, index: number) => K	A callback which will be invoked for each item in items.

Returns

Map<K, T[]>

Inherited from

AliasStore.groupBy

Defined in

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