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​
| Name | Type |
|---|---|
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​
| Name | Type |
|---|---|
iterable | Iterable<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@11507
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@12076
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@11564
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​
| Name | Type | Description |
|---|---|---|
index | number | The index of the element to obtain |
Returns​
undefined
Inherited from​
Collection.at
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:97
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:316
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​
| Name | Type | Description |
|---|---|---|
...collections | Collection<never, never>[] | Collections to merge |
Returns​
Collection<never, never>
Inherited from​
Collection.concat
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:325
delete​
â–¸ delete(key): boolean
Parameters​
| Name | Type |
|---|---|
key | never |
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​
| Name | Type |
|---|---|
T | extends Piece<PieceOptions, T> |
Parameters​
| Name | Type | Description |
|---|---|---|
store | Store<T> | The store to deregister. |
Returns​
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​
| Name | Type | Description |
|---|---|---|
other | Collection<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:359
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​
| Name | Type | Description |
|---|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => void | Function to execute for each element |
Returns​
Inherited from​
Collection.each
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:294
â–¸ each<T>(fn, thisArg): StoreRegistry
Type parameters​
| Name |
|---|
T |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => void |
thisArg | T |
Returns​
Inherited from​
Collection.each
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:295
ensure​
â–¸ ensure(key, defaultValueGenerator): never
Obtains the value of the given key if it exists, otherwise sets and returns the value provided by the default value generator.
example
collection.ensure(guildId, () => defaultGuildConfig);
Parameters​
| Name | Type | Description |
|---|---|---|
key | never | The key to get if it exists, or set otherwise |
defaultValueGenerator | (key: never, collection: StoreRegistry) => never | A function that generates the default value |
Returns​
never
Inherited from​
Collection.ensure
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:34
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​
| Name | Type | Description |
|---|---|---|
collection | Collection<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:335
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​
| Name | Type |
|---|---|
K2 | extends never |
Parameters​
| Name | Type | Description |
|---|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => key is K2 | Function 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:262
â–¸ every<V2>(fn): this is Collection<never, V2>
Type parameters​
| Name | Type |
|---|---|
V2 | extends never |
Parameters​
| Name | Type |
|---|---|
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:263
â–¸ every(fn): boolean
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => boolean |
Returns​
boolean
Inherited from​
Collection.every
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:264
â–¸ every<This, K2>(fn, thisArg): this is Collection<K2, never>
Type parameters​
| Name | Type |
|---|---|
This | This |
K2 | extends never |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => key is K2 |
thisArg | This |
Returns​
this is Collection<K2, never>
Inherited from​
Collection.every
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:265
â–¸ every<This, V2>(fn, thisArg): this is Collection<never, V2>
Type parameters​
| Name | Type |
|---|---|
This | This |
V2 | extends never |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => value is V2 |
thisArg | This |
Returns​
this is Collection<never, V2>
Inherited from​
Collection.every
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:266
â–¸ every<This>(fn, thisArg): boolean
Type parameters​
| Name |
|---|
This |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => boolean |
thisArg | This |
Returns​
boolean
Inherited from​
Collection.every
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:267
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​
| Name | Type |
|---|---|
K2 | extends never |
Parameters​
| Name | Type | Description |
|---|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => key is K2 | The 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:182
â–¸ filter<V2>(fn): Collection<never, V2>
Type parameters​
| Name | Type |
|---|---|
V2 | extends never |
Parameters​
| Name | Type |
|---|---|
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:183
â–¸ filter(fn): Collection<never, never>
Parameters​
| Name | Type |
|---|---|
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:184
â–¸ filter<This, K2>(fn, thisArg): Collection<K2, never>
Type parameters​
| Name | Type |
|---|---|
This | This |
K2 | extends never |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => key is K2 |
thisArg | This |
Returns​
Collection<K2, never>
Inherited from​
Collection.filter
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:185
â–¸ filter<This, V2>(fn, thisArg): Collection<never, V2>
Type parameters​
| Name | Type |
|---|---|
This | This |
V2 | extends never |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => value is V2 |
thisArg | This |
Returns​
Collection<never, V2>
Inherited from​
Collection.filter
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:186
â–¸ filter<This>(fn, thisArg): Collection<never, never>
Type parameters​
| Name |
|---|
This |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => boolean |
thisArg | This |
Returns​
Collection<never, never>
Inherited from​
Collection.filter
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:187
find​
â–¸ find<V2>(fn): undefined | V2
Searches for a single item where the given function returns a truthy value. This behaves like Array.find().
example
collection.find(user => user.username === 'Bob');
Type parameters​
| Name | Type |
|---|---|
V2 | extends never |
Parameters​
| Name | Type | Description |
|---|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => 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:142
â–¸ find(fn): undefined
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => boolean |
Returns​
undefined
Inherited from​
Collection.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 never |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => value is V2 |
thisArg | This |
Returns​
undefined | V2
Inherited from​
Collection.find
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:144
â–¸ find<This>(fn, thisArg): undefined
Type parameters​
| Name |
|---|
This |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => boolean |
thisArg | This |
Returns​
undefined
Inherited from​
Collection.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.
example
collection.findKey(user => user.username === 'Bob');
Type parameters​
| Name | Type |
|---|---|
K2 | extends never |
Parameters​
| Name | Type | Description |
|---|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => 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:157
â–¸ findKey(fn): undefined
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => boolean |
Returns​
undefined
Inherited from​
Collection.findKey
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:158
â–¸ findKey<This, K2>(fn, thisArg): undefined | K2
Type parameters​
| Name | Type |
|---|---|
This | This |
K2 | extends never |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => key is K2 |
thisArg | This |
Returns​
undefined | K2
Inherited from​
Collection.findKey
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:159
â–¸ findKey<This>(fn, thisArg): undefined
Type parameters​
| Name |
|---|
This |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => boolean |
thisArg | This |
Returns​
undefined
Inherited from​
Collection.findKey
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:160
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:58
â–¸ first(amount): never[]
Parameters​
| Name | Type |
|---|---|
amount | number |
Returns​
never[]
Inherited from​
Collection.first
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:59
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:68
â–¸ firstKey(amount): never[]
Parameters​
| Name | Type |
|---|---|
amount | number |
Returns​
never[]
Inherited from​
Collection.firstKey
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:69
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​
| Name | Type | Description |
|---|---|---|
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:214
â–¸ flatMap<T, This>(fn, thisArg): Collection<never, T>
Type parameters​
| Name |
|---|
T |
This |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => Collection<never, T> |
thisArg | This |
Returns​
Collection<never, T>
Inherited from​
Collection.flatMap
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:215
forEach​
â–¸ forEach(callbackfn, thisArg?): void
Parameters​
| Name | Type |
|---|---|
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​
| Name | Type |
|---|---|
K | extends never |
Parameters​
| Name | Type |
|---|---|
key | K |
Returns​
Inherited from​
Collection.get
Defined in​
projects/pieces/src/lib/structures/StoreRegistry.ts:96
â–¸ get(key): undefined
Parameters​
| Name | Type |
|---|---|
key | string |
Returns​
undefined
Inherited from​
Collection.get
Defined in​
projects/pieces/src/lib/structures/StoreRegistry.ts:97
has​
â–¸ has(key): true
Parameters​
| Name | Type |
|---|---|
key | never |
Returns​
true
Inherited from​
Collection.has
Defined in​
projects/pieces/src/lib/structures/StoreRegistry.ts:98
â–¸ has(key): false
Parameters​
| Name | Type |
|---|---|
key | string |
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​
| Name | Type | Description |
|---|---|---|
...keys | never[] | 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:42
hasAny​
â–¸ hasAny(...keys): boolean
Checks if any of the elements exist in the collection.
Parameters​
| Name | Type | Description |
|---|---|---|
...keys | never[] | 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:50
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​
| Name | Type | Description |
|---|---|---|
other | Collection<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:353
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​
| Name | Type | Description |
|---|---|---|
index | number | The index of the key to obtain |
Returns​
undefined
Inherited from​
Collection.keyAt
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:105
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:78
â–¸ last(amount): never[]
Parameters​
| Name | Type |
|---|---|
amount | number |
Returns​
never[]
Inherited from​
Collection.last
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:79
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:88
â–¸ lastKey(amount): never[]
Parameters​
| Name | Type |
|---|---|
amount | number |
Returns​
never[]
Inherited from​
Collection.lastKey
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:89
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​
| Name | Type | Description |
|---|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => 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:226
â–¸ map<This, T>(fn, thisArg): T[]
Type parameters​
| Name |
|---|
This |
T |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => T |
thisArg | This |
Returns​
T[]
Inherited from​
Collection.map
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:227
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​
| Name | Type | Description |
|---|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => T | Function 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:238
â–¸ mapValues<This, T>(fn, thisArg): Collection<never, T>
Type parameters​
| Name |
|---|
This |
T |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => T |
thisArg | This |
Returns​
Collection<never, T>
Inherited from​
Collection.mapValues
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:239
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​
| Name | Type |
|---|---|
K2 | extends never |
Parameters​
| Name | Type | Description |
|---|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => key is K2 | Function 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:198
â–¸ partition<V2>(fn): [Collection<never, V2>, Collection<never, never>]
Type parameters​
| Name | Type |
|---|---|
V2 | extends never |
Parameters​
| Name | Type |
|---|---|
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:199
â–¸ partition(fn): [Collection<never, never>, Collection<never, never>]
Parameters​
| Name | Type |
|---|---|
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:200
â–¸ partition<This, K2>(fn, thisArg): [Collection<K2, never>, Collection<never, never>]
Type parameters​
| Name | Type |
|---|---|
This | This |
K2 | extends never |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => key is K2 |
thisArg | This |
Returns​
[Collection<K2, never>, Collection<never, never>]
Inherited from​
Collection.partition
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:201
â–¸ partition<This, V2>(fn, thisArg): [Collection<never, V2>, Collection<never, never>]
Type parameters​
| Name | Type |
|---|---|
This | This |
V2 | extends never |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => value is V2 |
thisArg | This |
Returns​
[Collection<never, V2>, Collection<never, never>]
Inherited from​
Collection.partition
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:202
â–¸ partition<This>(fn, thisArg): [Collection<never, never>, Collection<never, never>]
Type parameters​
| Name |
|---|
This |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => boolean |
thisArg | This |
Returns​
[Collection<never, never>, Collection<never, never>]
Inherited from​
Collection.partition
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:203
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:113
â–¸ random(amount): never[]
Parameters​
| Name | Type |
|---|---|
amount | number |
Returns​
never[]
Inherited from​
Collection.random
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:114
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:122
â–¸ randomKey(amount): never[]
Parameters​
| Name | Type |
|---|---|
amount | number |
Returns​
never[]
Inherited from​
Collection.randomKey
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:123
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: never, key: never, collection: StoreRegistry) => 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:279
register​
â–¸ register<T>(store): StoreRegistry
Registers a store.
since 2.1.0
Type parameters​
| Name | Type |
|---|---|
T | extends Piece<PieceOptions, T> |
Parameters​
| Name | Type | Description |
|---|---|---|
store | Store<T> | The store to register. |
Returns​
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​
| Name | Type | Description |
|---|---|---|
rootDirectory | string | The root directory to register pieces at. |
Returns​
void
Defined in​
projects/pieces/src/lib/structures/StoreRegistry.ts:68
reverse​
â–¸ reverse(): StoreRegistry
Identical to Array.reverse() but returns a Collection instead of an Array.
Returns​
Inherited from​
Collection.reverse
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:128
set​
â–¸ set(key, value): StoreRegistry
Parameters​
| Name | Type |
|---|---|
key | never |
value | never |
Returns​
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: never, key: never, collection: StoreRegistry) => 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:250
â–¸ some<T>(fn, thisArg): boolean
Type parameters​
| Name |
|---|
T |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => boolean |
thisArg | T |
Returns​
boolean
Inherited from​
Collection.some
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:251
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​
| Name | Type | Description |
|---|---|---|
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​
Inherited from​
Collection.sort
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:347
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​
| Name | Type | Description |
|---|---|---|
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:372
sweep​
â–¸ sweep(fn): number
Removes items that satisfy the provided filter function.
Parameters​
| Name | Type | Description |
|---|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => 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:169
â–¸ sweep<T>(fn, thisArg): number
Type parameters​
| Name |
|---|
T |
Parameters​
| Name | Type |
|---|---|
fn | (value: never, key: never, collection: StoreRegistry) => boolean |
thisArg | T |
Returns​
number
Inherited from​
Collection.sweep
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:170
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​
| Name | Type | Description |
|---|---|---|
fn | (collection: StoreRegistry) => void | Function to execute |
Returns​
Inherited from​
Collection.tap
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:308
â–¸ tap<T>(fn, thisArg): StoreRegistry
Type parameters​
| Name |
|---|
T |
Parameters​
| Name | Type |
|---|---|
fn | (collection: StoreRegistry) => void |
thisArg | T |
Returns​
Inherited from​
Collection.tap
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:309
toJSON​
â–¸ toJSON(): never[]
Returns​
never[]
Inherited from​
Collection.toJSON
Defined in​
node_modules/@discordjs/collection/dist/index.d.ts:373
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