Skip to main content

Class: StoreRegistry

A strict-typed store registry. This is available in container.

since 2.1.0

example

// Adding new stores

// Register the store:
container.stores.register(new RouteStore());

// Augment Sapphire to add the new store, in case of a JavaScript
// project, this can be moved to an `Augments.d.ts` (or any other name)
// file somewhere:
declare module '@sapphire/pieces' {
export interface StoreRegistryEntries {
routes: RouteStore;
}
}

Hierarchy

  • Collection<Key, Value>

    โ†ณ StoreRegistry

Constructors

constructor

โ€ข new StoreRegistry(entries?)

Parameters

NameType
entries?null | readonly readonly [never, never][]

Inherited from

Collection<Key, Value>.constructor

Defined in

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

โ€ข new StoreRegistry(iterable)

Parameters

NameType
iterableIterable<readonly [never, never]>

Inherited from

Collection<Key, Value>.constructor

Defined in

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

Properties

[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


size

โ€ข Readonly size: number

Inherited from

Collection.size

Defined in

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


[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

Methods

[iterator]

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

Returns an iterable of entries in the map.

Returns

IterableIterator<[never, never]>

Inherited from

Collection.__@iterator@9188

Defined in

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


at

โ–ธ at(index?): undefined

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

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<never, never>

Creates an identical shallow copy of this collection.

example const newColl = someColl.clone();

Returns

Collection<never, never>

Inherited from

Collection.clone

Defined in

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


concat

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

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<never, never>[]Collections to merge

Returns

Collection<never, never>

Inherited from

Collection.concat

Defined in

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


delete

โ–ธ delete(key): boolean

Parameters

NameType
keynever

Returns

boolean

Inherited from

Collection.delete

Defined in

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


deregister

โ–ธ deregister<T>(store): StoreRegistry

Deregisters a store.

since 2.1.0

Type parameters

NameType
Textends Piece<PieceOptions, T>

Parameters

NameTypeDescription
storeStore<T>The store to deregister.

Returns

StoreRegistry

Defined in

projects/pieces/src/lib/structures/StoreRegistry.ts:89


difference

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

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<never, never>The other Collection to filter against

Returns

Collection<never, never>

Inherited from

Collection.difference

Defined in

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


each

โ–ธ each(fn): StoreRegistry

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: never, key: never, collection: StoreRegistry) => voidFunction to execute for each element

Returns

StoreRegistry

Inherited from

Collection.each

Defined in

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

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

Type parameters

Name
T

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => void
thisArgT

Returns

StoreRegistry

Inherited from

Collection.each

Defined in

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


entries

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

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

Returns

IterableIterator<[never, never]>

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<never, never>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, never>

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

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

Type parameters

NameType
K2extends never

Parameters

NameTypeDescription
fn(value: never, key: never, collection: StoreRegistry) => key is K2Function used to test (should return a boolean)

Returns

this is Collection<K2, never>

Inherited from

Collection.every

Defined in

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

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

Type parameters

NameType
V2extends never

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => value is V2

Returns

this is Collection<never, V2>

Inherited from

Collection.every

Defined in

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

โ–ธ every(fn): boolean

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => 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, never>

Type parameters

NameType
ThisThis
K2extends never

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => key is K2
thisArgThis

Returns

this is Collection<K2, never>

Inherited from

Collection.every

Defined in

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

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

Type parameters

NameType
ThisThis
V2extends never

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => value is V2
thisArgThis

Returns

this is Collection<never, 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: never, key: never, collection: StoreRegistry) => 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, never>

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

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

Type parameters

NameType
K2extends never

Parameters

NameTypeDescription
fn(value: never, key: never, collection: StoreRegistry) => key is K2The function to test with (should return boolean)

Returns

Collection<K2, never>

Inherited from

Collection.filter

Defined in

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

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

Type parameters

NameType
V2extends never

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => value is V2

Returns

Collection<never, V2>

Inherited from

Collection.filter

Defined in

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

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

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => boolean

Returns

Collection<never, never>

Inherited from

Collection.filter

Defined in

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

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

Type parameters

NameType
ThisThis
K2extends never

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => key is K2
thisArgThis

Returns

Collection<K2, never>

Inherited from

Collection.filter

Defined in

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

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

Type parameters

NameType
ThisThis
V2extends never

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => value is V2
thisArgThis

Returns

Collection<never, V2>

Inherited from

Collection.filter

Defined in

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

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

Type parameters

Name
This

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => boolean
thisArgThis

Returns

Collection<never, never>

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 never

Parameters

NameTypeDescription
fn(value: never, key: never, collection: StoreRegistry) => 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

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => boolean

Returns

undefined

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 never

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => 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

Type parameters

Name
This

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => boolean
thisArgThis

Returns

undefined

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 never

Parameters

NameTypeDescription
fn(value: never, key: never, collection: StoreRegistry) => 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

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => boolean

Returns

undefined

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 never

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => 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

Type parameters

Name
This

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => boolean
thisArgThis

Returns

undefined

Inherited from

Collection.findKey

Defined in

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


first

โ–ธ first(): undefined

Obtains the first value(s) in this collection.

Returns

undefined

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): never[]

Parameters

NameType
amountnumber

Returns

never[]

Inherited from

Collection.first

Defined in

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


firstKey

โ–ธ firstKey(): undefined

Obtains the first key(s) in this collection.

Returns

undefined

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): never[]

Parameters

NameType
amountnumber

Returns

never[]

Inherited from

Collection.firstKey

Defined in

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


flatMap

โ–ธ flatMap<T>(fn): Collection<never, 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: never, key: never, collection: StoreRegistry) => Collection<never, T>Function that produces a new Collection

Returns

Collection<never, T>

Inherited from

Collection.flatMap

Defined in

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

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

Type parameters

Name
T
This

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => Collection<never, T>
thisArgThis

Returns

Collection<never, 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: never, key: never, map: Map<never, never>) => void
thisArg?any

Returns

void

Inherited from

Collection.forEach

Defined in

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


get

โ–ธ get<K>(key): StoreRegistryEntries[K]

Type parameters

NameType
Kextends never

Parameters

NameType
keyK

Returns

StoreRegistryEntries[K]

Inherited from

Collection.get

Defined in

projects/pieces/src/lib/structures/StoreRegistry.ts:96

โ–ธ get(key): undefined

Parameters

NameType
keystring

Returns

undefined

Inherited from

Collection.get

Defined in

projects/pieces/src/lib/structures/StoreRegistry.ts:97


has

โ–ธ has(key): true

Parameters

NameType
keynever

Returns

true

Inherited from

Collection.has

Defined in

projects/pieces/src/lib/structures/StoreRegistry.ts:98

โ–ธ has(key): false

Parameters

NameType
keystring

Returns

false

Inherited from

Collection.has

Defined in

projects/pieces/src/lib/structures/StoreRegistry.ts:99


hasAll

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

Checks if all of the elements exist in the collection.

Parameters

NameTypeDescription
...keysnever[]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
...keysnever[]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


intersect

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

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

Parameters

NameTypeDescription
otherCollection<never, never>The other Collection to filter against

Returns

Collection<never, never>

Inherited from

Collection.intersect

Defined in

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


keyAt

โ–ธ keyAt(index?): undefined

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

Inherited from

Collection.keyAt

Defined in

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


keys

โ–ธ keys(): IterableIterator<never>

Returns an iterable of keys in the map

Returns

IterableIterator<never>

Inherited from

Collection.keys

Defined in

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


last

โ–ธ last(): undefined

Obtains the last value(s) in this collection.

Returns

undefined

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): never[]

Parameters

NameType
amountnumber

Returns

never[]

Inherited from

Collection.last

Defined in

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


lastKey

โ–ธ lastKey(): undefined

Obtains the last key(s) in this collection.

Returns

undefined

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): never[]

Parameters

NameType
amountnumber

Returns

never[]

Inherited from

Collection.lastKey

Defined in

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


load

โ–ธ load(): Promise<void>

Loads all the registered stores.

since 2.1.0

Returns

Promise<void>

Defined in

projects/pieces/src/lib/structures/StoreRegistry.ts:35


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: never, key: never, collection: StoreRegistry) => 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: never, key: never, collection: StoreRegistry) => T
thisArgThis

Returns

T[]

Inherited from

Collection.map

Defined in

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


mapValues

โ–ธ mapValues<T>(fn): Collection<never, 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: never, key: never, collection: StoreRegistry) => TFunction that produces an element of the new collection, taking three arguments

Returns

Collection<never, T>

Inherited from

Collection.mapValues

Defined in

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

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

Type parameters

Name
This
T

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => T
thisArgThis

Returns

Collection<never, T>

Inherited from

Collection.mapValues

Defined in

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


partition

โ–ธ partition<K2>(fn): [Collection<K2, never>, Collection<never, never>]

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 never

Parameters

NameTypeDescription
fn(value: never, key: never, collection: StoreRegistry) => key is K2Function used to test (should return a boolean)

Returns

[Collection<K2, never>, Collection<never, never>]

Inherited from

Collection.partition

Defined in

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

โ–ธ partition<V2>(fn): [Collection<never, V2>, Collection<never, never>]

Type parameters

NameType
V2extends never

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => value is V2

Returns

[Collection<never, V2>, Collection<never, never>]

Inherited from

Collection.partition

Defined in

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

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

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => boolean

Returns

[Collection<never, never>, Collection<never, never>]

Inherited from

Collection.partition

Defined in

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

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

Type parameters

NameType
ThisThis
K2extends never

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => key is K2
thisArgThis

Returns

[Collection<K2, never>, Collection<never, never>]

Inherited from

Collection.partition

Defined in

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

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

Type parameters

NameType
ThisThis
V2extends never

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => value is V2
thisArgThis

Returns

[Collection<never, V2>, Collection<never, never>]

Inherited from

Collection.partition

Defined in

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

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

Type parameters

Name
This

Parameters

NameType
fn(value: never, key: never, collection: StoreRegistry) => boolean
thisArgThis

Returns

[Collection<never, never>, Collection<never, never>]

Inherited from

Collection.partition

Defined in

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


random

โ–ธ random(): undefined

Obtains unique random value(s) from this collection.

Returns

undefined

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): never[]

Parameters

NameType
amountnumber

Returns

never[]

Inherited from

Collection.random

Defined in

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


randomKey

โ–ธ randomKey(): undefined

Obtains unique random key(s) from this collection.

Returns

undefined

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): never[]

Parameters

NameType
amountnumber

Returns

never[]

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: never, key: never, collection: StoreRegistry) => 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


register

โ–ธ register<T>(store): StoreRegistry

Registers a store.

since 2.1.0

Type parameters

NameType
Textends Piece<PieceOptions, T>

Parameters

NameTypeDescription
storeStore<T>The store to register.

Returns

StoreRegistry

Defined in

projects/pieces/src/lib/structures/StoreRegistry.ts:79


registerPath

โ–ธ registerPath(rootDirectory?): void

Registers all user directories from the process working directory, the default value is obtained by assuming CommonJS (high accuracy) but with fallback for ECMAScript Modules (reads package.json's main entry, fallbacks to process.cwd()).

By default, if you have this folder structure:

/home/me/my-bot
โ”œโ”€ src
โ”‚ โ”œโ”€ commands
โ”‚ โ”œโ”€ events
โ”‚ โ””โ”€ main.js
โ””โ”€ package.json

And you run node src/main.js, the directories /home/me/my-bot/src/commands and /home/me/my-bot/src/events will be registered for the commands and events stores respectively, since both directories are located in the same directory as your main file.

Note: this also registers directories for all other stores, even if they don't have a folder, this allows you to create new pieces and hot-load them later anytime.

since 2.1.0

Parameters

NameTypeDescription
rootDirectorystringThe root directory to register pieces at.

Returns

void

Defined in

projects/pieces/src/lib/structures/StoreRegistry.ts:68


set

โ–ธ set(key, value): StoreRegistry

Parameters

NameType
keynever
valuenever

Returns

StoreRegistry

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: never, key: never, collection: StoreRegistry) => 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: never, key: never, collection: StoreRegistry) => boolean
thisArgT

Returns

boolean

Inherited from

Collection.some

Defined in

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


sort

โ–ธ sort(compareFunction?): StoreRegistry

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<never, never>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

StoreRegistry

Inherited from

Collection.sort

Defined in

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


sorted

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

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<never, never>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<never, never>

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: never, key: never, collection: StoreRegistry) => 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: never, key: never, collection: StoreRegistry) => boolean
thisArgT

Returns

number

Inherited from

Collection.sweep

Defined in

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


tap

โ–ธ tap(fn): StoreRegistry

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: StoreRegistry) => voidFunction to execute

Returns

StoreRegistry

Inherited from

Collection.tap

Defined in

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

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

Type parameters

Name
T

Parameters

NameType
fn(collection: StoreRegistry) => void
thisArgT

Returns

StoreRegistry

Inherited from

Collection.tap

Defined in

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


toJSON

โ–ธ toJSON(): never[]

Returns

never[]

Inherited from

Collection.toJSON

Defined in

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


values

โ–ธ values(): IterableIterator<never>

Returns an iterable of values in the map

Returns

IterableIterator<never>

Inherited from

Collection.values

Defined in

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