Class: Store<T>

The store class which contains Pieces.

Type parameters

Name	Type
`T`	extends `Piece`

Hierarchy

Collection<string, T>
↳ Store
↳↳ AliasStore

Constructors

constructor

• new Store<T>(constructor, options)

Type parameters

Name	Type
`T`	extends `Piece`<`PieceOptions`, `T`>

Parameters

Name	Type	Description
`constructor`	`Constructor`<`T`>	The piece constructor this store loads.
`options`	`StoreOptions`<`T`>	The options for the store.

Overrides

Collection<string, T\>.constructor

Defined in

projects/pieces/src/lib/structures/Store.ts:62

Properties

Constructor

• Readonly Constructor: Constructor<T>

Defined in

projects/pieces/src/lib/structures/Store.ts:53

[toStringTag]

• Readonly [toStringTag]: string

Inherited from

Collection.__@toStringTag@9131

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

name

• Readonly name: string

Defined in

projects/pieces/src/lib/structures/Store.ts:54

paths

• Readonly paths: Set<string>

Defined in

projects/pieces/src/lib/structures/Store.ts:55

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

projects/pieces/src/lib/structures/Store.ts:56

[species]

▪ Static Readonly [species]: MapConstructor

Inherited from

Collection.__@species@9700

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 LoaderStrategy, which is constructed on demand when a store is constructed, when none was set beforehand.

Defined in

projects/pieces/src/lib/structures/Store.ts:301

logger

▪ Static logger: null | StoreLogger = null

The default logger, defaults to null.

Defined in

projects/pieces/src/lib/structures/Store.ts:306

Accessors

container

• get container(): Container

A reference to the Container object for ease of use.

see container

Returns

Container

Defined in

projects/pieces/src/lib/structures/Store.ts:74

Methods

[iterator]

▸ [iterator](): IterableIterator<[string, T]>

Returns an iterable of entries in the map.

Returns

IterableIterator<[string, T]>

Inherited from

Collection.__@iterator@9188

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

Name	Type	Description
`index?`	`number`	The 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

Name	Type	Description
`...collections`	`Collection`<`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

Name	Type	Description
`Ctor`	`ILoaderResultEntry`<`T`>	The Piece's constructor used to build the instance.
`data`	`HydratedModuleData`	The module's information

Returns

T

An instance of the constructed piece.

Defined in

projects/pieces/src/lib/structures/Store.ts:238

delete

▸ delete(key): boolean

Parameters

Name	Type
`key`	`string`

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

Name	Type	Description
`other`	`Collection`<`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

Name	Type	Description
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `void`	Function 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

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `void`
`thisArg`	`T`

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

Name	Type	Description
`collection`	`Collection`<`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

Name	Type
`K2`	extends `string`

Parameters

Name	Type	Description
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => key is K2	Function 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

Name	Type
`V2`	extends `Piece`<`PieceOptions`, `V2`>

Parameters

Name	Type
`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

Name	Type
`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

Name	Type
`This`	`This`
`K2`	extends `string`

Parameters

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => key is K2
`thisArg`	`This`

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

Name	Type
`This`	`This`
`V2`	extends `Piece`<`PieceOptions`, `V2`>

Parameters

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => value is V2
`thisArg`	`This`

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

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `boolean`
`thisArg`	`This`

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

Name	Type
`K2`	extends `string`

Parameters

Name	Type	Description
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => key is K2	The 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

Name	Type
`V2`	extends `Piece`<`PieceOptions`, `V2`>

Parameters

Name	Type
`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

Name	Type
`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

Name	Type
`This`	`This`
`K2`	extends `string`

Parameters

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => key is K2
`thisArg`	`This`

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

Name	Type
`This`	`This`
`V2`	extends `Piece`<`PieceOptions`, `V2`>

Parameters

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => value is V2
`thisArg`	`This`

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

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `boolean`
`thisArg`	`This`

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

Name	Type
`V2`	extends `Piece`<`PieceOptions`, `V2`>

Parameters

Name	Type	Description
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => value is V2	The 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

Name	Type
`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

Name	Type
`This`	`This`
`V2`	extends `Piece`<`PieceOptions`, `V2`>

Parameters

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => value is V2
`thisArg`	`This`

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

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `boolean`
`thisArg`	`This`

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

Name	Type
`K2`	extends `string`

Parameters

Name	Type	Description
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => key is K2	The 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

Name	Type
`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

Name	Type
`This`	`This`
`K2`	extends `string`

Parameters

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => key is K2
`thisArg`	`This`

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

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `boolean`
`thisArg`	`This`

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

Name	Type
`amount`	`number`

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

Name	Type
`amount`	`number`

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

Name	Type	Description
`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

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `Collection`<`string`, `T`>
`thisArg`	`This`

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

Name	Type
`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

Name	Type
`key`	`string`

Returns

undefined | T

Inherited from

Collection.get

Defined in

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

has

▸ has(key): boolean

Parameters

Name	Type
`key`	`string`

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

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

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

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

Collection.hasAny

Defined in

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

hydrateModuleData

▸ Private hydrateModuleData(root, data): HydratedModuleData

Adds the final module data properties.

Parameters

Name	Type	Description
`root`	`string`	The root directory to add.
`data`	`ModuleData`	The module data returned from ILoaderStrategy.filter.

Returns

HydratedModuleData

The finished module data.

Defined in

projects/pieces/src/lib/structures/Store.ts:248

insert

▸ insert(piece): Promise<T>

Inserts a piece into the store.

Parameters

Name	Type	Description
`piece`	`T`	The piece to be inserted into the store.

Returns

Promise<T>

The inserted piece.

Defined in

projects/pieces/src/lib/structures/Store.ts:201

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

Name	Type	Description
`other`	`Collection`<`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

Name	Type	Description
`index?`	`number`	The 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

Name	Type
`amount`	`number`

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

Name	Type
`amount`	`number`

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

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<T[]>

All the loaded pieces.

Defined in

projects/pieces/src/lib/structures/Store.ts:100

loadAll

▸ loadAll(): Promise<void>

Loads all pieces from all directories specified by paths.

Returns

Promise<void>

Defined in

projects/pieces/src/lib/structures/Store.ts:155

loadPath

▸ Private loadPath(root): AsyncIterableIterator<T>

Loads a directory into the store.

Parameters

Name	Type	Description
`root`	`string`	The directory to load the pieces from.

Returns

AsyncIterableIterator<T>

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

Defined in

projects/pieces/src/lib/structures/Store.ts:257

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

Name	Type	Description
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `T`	Function 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

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `T`
`thisArg`	`This`

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

Name	Type	Description
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `T`	Function 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

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `T`
`thisArg`	`This`

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

Name	Type
`K2`	extends `string`

Parameters

Name	Type	Description
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => key is K2	Function 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

Name	Type
`V2`	extends `Piece`<`PieceOptions`, `V2`>

Parameters

Name	Type
`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

Name	Type
`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

Name	Type
`This`	`This`
`K2`	extends `string`

Parameters

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => key is K2
`thisArg`	`This`

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

Name	Type
`This`	`This`
`V2`	extends `Piece`<`PieceOptions`, `V2`>

Parameters

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => value is V2
`thisArg`	`This`

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

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `boolean`
`thisArg`	`This`

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

Name	Type
`amount`	`number`

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

Name	Type
`amount`	`number`

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

Name	Type	Description
`fn`	(`accumulator`: `T`, `value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `T`	Function used to reduce, taking four arguments; `accumulator`, `currentValue`, `currentKey`, and `collection`
`initialValue?`	`T`	Starting 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

Name	Type	Description
`path`	`string`	The path to be added.

Returns

Store<T>

Defined in

projects/pieces/src/lib/structures/Store.ts:88

resolve

▸ resolve(name): T

Resolves a piece by its name or its instance.

Parameters

Name	Type	Description
`name`	`string` \| `T`	The name of the piece or the instance itself.

Returns

T

The resolved piece.

Defined in

projects/pieces/src/lib/structures/Store.ts:185

set

▸ set(key, value): Store<T>

Parameters

Name	Type
`key`	`string`
`value`	`T`

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

Name	Type	Description
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `boolean`	Function 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

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `boolean`
`thisArg`	`T`

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

Name	Type	Description
`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

Name	Type	Description
`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

Name	Type	Description
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `boolean`	Function 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

Name	Type
`fn`	(`value`: `T`, `key`: `string`, `collection`: `Store`<`T`>) => `boolean`
`thisArg`	`T`

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

Name	Type	Description
`fn`	(`collection`: `Store`<`T`>) => `void`	Function 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

Name	Type
`fn`	(`collection`: `Store`<`T`>) => `void`
`thisArg`	`T`

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

Name	Type	Description
`name`	`string` \| `T`	The name of the file to load.

Returns

Promise<T>

Returns the piece that was unloaded.

Defined in

projects/pieces/src/lib/structures/Store.ts:122

unloadAll

▸ unloadAll(): Promise<T[]>

Unloads all pieces from the store.

Returns

Promise<T[]>

Defined in

projects/pieces/src/lib/structures/Store.ts:139

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

walk

▸ Private walk(path): AsyncIterableIterator<string>

Retrieves all possible pieces.

Parameters

Name	Type	Description
`path`	`string`	The directory to load the pieces from.

Returns

AsyncIterableIterator<string>

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

Defined in

projects/pieces/src/lib/structures/Store.ts:281

Type parameters​

Hierarchy​

Constructors​

constructor​

Type parameters​

Parameters​

Overrides​

Defined in​

Properties​

Constructor​

Defined in​

[toStringTag]​

Inherited from​

Defined in​

constructor​

Inherited from​

Defined in​

name​

Defined in​

paths​

Defined in​

size​

Inherited from​

Defined in​

strategy​

Defined in​

[species]​

Inherited from​

Defined in​

default​

Inherited from​

Defined in​

defaultStrategy​

Defined in​

logger​

Defined in​

Accessors​

container​

Returns​

Defined in​

Methods​

[iterator]​

Returns​

Inherited from​

Defined in​

at​

Parameters​

Returns​

Inherited from​

Defined in​

clear​

Returns​

Inherited from​

Defined in​

clone​

Returns​

Inherited from​

Defined in​

concat​

Parameters​

Returns​

Inherited from​

Defined in​

construct​

Parameters​

Returns​

Defined in​

delete​

Parameters​

Returns​

Inherited from​

Defined in​

difference​

Parameters​

Returns​

Inherited from​

Defined in​

each​

Parameters​

Returns​

Type parameters

Hierarchy

Constructors

constructor

Type parameters

Parameters

Overrides

Defined in

Properties

Constructor

Defined in

[toStringTag]

Inherited from

Defined in

constructor

Inherited from

Defined in

name

Defined in

paths

Defined in

size

Inherited from

Defined in

strategy

Defined in

[species]

Inherited from

Defined in

default

Inherited from

Defined in

defaultStrategy

Defined in

logger

Defined in

Accessors

container

Returns

Defined in

Methods

[iterator]

Returns

Inherited from

Defined in

at

Parameters

Returns

Inherited from

Defined in

clear

Returns

Inherited from

Defined in

clone

Returns

Inherited from

Defined in

concat

Parameters

Returns

Inherited from

Defined in

construct

Parameters

Returns

Defined in

delete

Parameters

Returns

Inherited from

Defined in

difference

Parameters

Returns

Inherited from

Defined in

each

Parameters

Returns