Class: InteractionHandlerStore
The store class which contains Pieces.
Hierarchy
-
Store
<InteractionHandler
,"interaction-handlers"
>↳
InteractionHandlerStore
Constructors
constructor
• new InteractionHandlerStore(): InteractionHandlerStore
Returns
Overrides
Defined in
projects/framework/src/lib/structures/InteractionHandlerStore.ts:8
Properties
#private
• Private
#private: any
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:461
Constructor
• Readonly
Constructor: AbstractConstructor
<InteractionHandler
<InteractionHandlerOptions
>>
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:462
[toStringTag]
• Readonly
[toStringTag]: string
Inherited from
Defined in
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:137
constructor
• constructor: CollectionConstructor
Inherited from
Store.constructor
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:21
name
• Readonly
name: "interaction-handlers"
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:463
paths
• Readonly
paths: Set
<string
>
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:464
size
• Readonly
size: number
Inherited from
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:45
strategy
• Readonly
strategy: ILoaderStrategy
<InteractionHandler
<InteractionHandlerOptions
>>
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:465
[species]
▪ Static
Readonly
[species]: MapConstructor
Inherited from
Defined in
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:319
defaultStrategy
▪ Static
defaultStrategy: ILoaderStrategy
<any
>
The default strategy, defaults to LoaderStrategy, which is constructed on demand when a store is constructed, when none was set beforehand.
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:584
logger
▪ Static
logger: null
| StoreLogger
The default logger, defaults to null
.
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:588
Accessors
container
• get
container(): Container
A reference to the Container object for ease of use.
Returns
See
container
Inherited from
Store.container
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:479
Methods
[iterator]
▸ [iterator](): IterableIterator
<[string
, InteractionHandler
<InteractionHandlerOptions
>]>
Returns an iterable of entries in the map.
Returns
IterableIterator
<[string
, InteractionHandler
<InteractionHandlerOptions
>]>
Inherited from
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:119
at
▸ at(index
): undefined
| InteractionHandler
<InteractionHandlerOptions
>
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
| InteractionHandler
<InteractionHandlerOptions
>
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:98
clear
▸ clear(): void
Returns
void
Inherited from
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:20
clone
▸ clone(): Collection
<string
, InteractionHandler
<InteractionHandlerOptions
>>
Creates an identical shallow copy of this collection.
Returns
Collection
<string
, InteractionHandler
<InteractionHandlerOptions
>>
Example
const newColl = someColl.clone();
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:328
concat
▸ concat(...collections
): Collection
<string
, InteractionHandler
<InteractionHandlerOptions
>>
Combines this collection with others into a new collection. None of the source collections are modified.
Parameters
Name | Type | Description |
---|---|---|
...collections | ReadonlyCollection <string , InteractionHandler <InteractionHandlerOptions >>[] | Collections to merge |
Returns
Collection
<string
, InteractionHandler
<InteractionHandlerOptions
>>
Example
const newColl = someColl.concat(someOtherColl, anotherColl, ohBoyAColl);
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:338
construct
▸ construct(Ctor
, data
): InteractionHandler
<InteractionHandlerOptions
>
Constructs a Piece instance.
Parameters
Name | Type | Description |
---|---|---|
Ctor | ILoaderResultEntry <InteractionHandler <InteractionHandlerOptions >> | The Piece's constructor used to build the instance. |
data | HydratedModuleData | The module's information |
Returns
InteractionHandler
<InteractionHandlerOptions
>
An instance of the constructed piece.
Inherited from
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:566
delete
▸ delete(key
): boolean
Parameters
Name | Type |
---|---|
key | string |
Returns
boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:24
difference
▸ difference<T
>(other
): Collection
<string
, InteractionHandler
<InteractionHandlerOptions
> | T
>
The difference method returns a new structure containing items where the key is present in one of the original structures but not the other.
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
other | ReadonlyCollection <string , T > | The other Collection to filter against |
Returns
Collection
<string
, InteractionHandler
<InteractionHandlerOptions
> | T
>
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:378
each
▸ each(fn
): this
Identical to Map.forEach(), but returns the collection instead of undefined.
Parameters
Name | Type | Description |
---|---|---|
fn | (value : InteractionHandler <InteractionHandlerOptions >, key : string , collection : this ) => void | Function to execute for each element |
Returns
this
Example
collection
.each(user => console.log(user.username))
.filter(user => user.bot)
.each(user => console.log(user.username));
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:303
▸ each<T
>(fn
, thisArg
): this
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
fn | (this : T , value : InteractionHandler <InteractionHandlerOptions >, key : string , collection : this ) => void |
thisArg | T |
Returns
this
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:304
ensure
▸ ensure(key
, defaultValueGenerator
): InteractionHandler
<InteractionHandlerOptions
>
Obtains the value of the given key if it exists, otherwise sets and returns the value provided by the default value generator.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key to get if it exists, or set otherwise |
defaultValueGenerator | (key : string , collection : this ) => InteractionHandler <InteractionHandlerOptions > | A function that generates the default value |
Returns
InteractionHandler
<InteractionHandlerOptions
>
Example
collection.ensure(guildId, () => defaultGuildConfig);
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:41
entries
▸ entries(): IterableIterator
<[string
, InteractionHandler
<InteractionHandlerOptions
>]>
Returns an iterable of key, value pairs for every entry in the map.
Returns
IterableIterator
<[string
, InteractionHandler
<InteractionHandlerOptions
>]>
Inherited from
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:124
equals
▸ equals(collection
): boolean
Checks if this collection shares identical items with another. This is different to checking for equality using equal-signs, because the collections may be different objects, but contain the same data.
Parameters
Name | Type | Description |
---|---|---|
collection | ReadonlyCollection <string , InteractionHandler <InteractionHandlerOptions >> | Collection to compare with |
Returns
boolean
Whether the collections have identical contents
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:347
every
▸ every<K2
>(fn
): this is Collection<K2, InteractionHandler<InteractionHandlerOptions>>
Checks if all items passes a test. Identical in behavior to Array.every().
Type parameters
Name | Type |
---|---|
K2 | extends string |
Parameters
Name | Type | Description |
---|---|---|
fn | (value : InteractionHandler <InteractionHandlerOptions >, key : string , collection : this ) => key is K2 | Function used to test (should return a boolean) |
Returns
this is Collection<K2, InteractionHandler<InteractionHandlerOptions>>
Example
collection.every(user => !user.bot);
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:269
▸ every<V2
>(fn
): this is Collection<string, V2>
Type parameters
Name | Type |
---|---|
V2 | extends InteractionHandler <InteractionHandlerOptions > |
Parameters
Name | Type |
---|---|
fn | (value : InteractionHandler <InteractionHandlerOptions >, key : string , collection : this ) => value is V2 |
Returns
this is Collection<string, V2>
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:270
▸ every(fn
): boolean
Parameters
Name | Type |
---|---|
fn | (value : InteractionHandler <InteractionHandlerOptions >, key : string , collection : this ) => unknown |
Returns
boolean
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:271
▸ every<This
, K2
>(fn
, thisArg
): this is Collection<K2, InteractionHandler<InteractionHandlerOptions>>
Type parameters
Name | Type |
---|---|
This | This |
K2 | extends string |
Parameters
Name | Type |
---|---|
fn | (this : This , value : InteractionHandler <InteractionHandlerOptions >, key : string , collection : this ) => key is K2 |
thisArg | This |
Returns
this is Collection<K2, InteractionHandler<InteractionHandlerOptions>>
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:272
▸ every<This
, V2
>(fn
, thisArg
): this is Collection<string, V2>
Type parameters
Name | Type |
---|---|
This | This |
V2 | extends InteractionHandler <InteractionHandlerOptions > |
Parameters
Name | Type |
---|---|
fn | (this : This , value : InteractionHandler <InteractionHandlerOptions >, key : string , collection : this ) => value is V2 |
thisArg | This |
Returns
this is Collection<string, V2>
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:273
▸ every<This
>(fn
, thisArg
): boolean
Type parameters
Name |
---|
This |
Parameters
Name | Type |
---|---|
fn | (this : This , value : InteractionHandler <InteractionHandlerOptions >, key : string , collection : this ) => unknown |
thisArg | This |
Returns
boolean
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:274
filter
▸ filter<K2
>(fn
): Collection
<K2
, InteractionHandler
<InteractionHandlerOptions
>>
Identical to Array.filter(), but returns a Collection instead of an Array.
Type parameters
Name | Type |
---|---|
K2 | extends string |
Parameters
Name | Type | Description |
---|---|---|
fn | (value : InteractionHandler <InteractionHandlerOptions >, key : string , collection : this ) => key is K2 | The function to test with (should return boolean) |
Returns
Collection
<K2
, InteractionHandler
<InteractionHandlerOptions
>>
Example
collection.filter(user => user.username === 'Bob');
Inherited from
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:183