Class: UtilitiesStore
utilities-store/src.UtilitiesStore
Hierarchy
Store
<Utility
>↳
UtilitiesStore
Constructors
constructor
• new UtilitiesStore()
Overrides
Store<Utility\>.constructor
Defined in
projects/plugins/packages/utilities-store/src/lib/UtilitiesStore.ts:8
Properties
Constructor
• Readonly
Constructor: AbstractConstructor
<Utility
>
Inherited from
Store.Constructor
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:284
[toStringTag]
• Readonly
[toStringTag]: string
Inherited from
Store.__@toStringTag@190767
Defined in
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:135
constructor
• constructor: CollectionConstructor
Inherited from
Store.constructor
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:21
name
• Readonly
name: string
Inherited from
Store.name
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:285
paths
• Readonly
paths: Set
<string
>
Inherited from
Store.paths
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:286
size
• Readonly
size: number
Inherited from
Store.size
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:48
strategy
• Readonly
strategy: ILoaderStrategy
<Utility
>
Inherited from
Store.strategy
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:287
[species]
▪ Static
Readonly
[species]: MapConstructor
Inherited from
Store.__@species@190911
Defined in
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:317
defaultStrategy
▪ Static
defaultStrategy: ILoaderStrategy
<any
>
Inherited from
Store.defaultStrategy
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:372
logger
▪ Static
logger: null
| StoreLogger
Inherited from
Store.logger
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:376
Accessors
container
• get
container(): Container
Returns
Container
Inherited from
Store.container
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:297
Methods
[iterator]
▸ [iterator](): IterableIterator
<[string
, Utility
]>
Returns
IterableIterator
<[string
, Utility
]>
Inherited from
Store.__@iterator@190605
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:121
at
▸ at(index
): undefined
| Utility
Parameters
Name | Type | Description |
---|---|---|
index | number |
Returns
undefined
| Utility
Inherited from
Store.at
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:98
clear
▸ clear(): void
Returns
void
Inherited from
Store.clear
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:23
clone
▸ clone(): Collection
<string
, Utility
>
Returns
Collection
<string
, Utility
>
Inherited from
Store.clone
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:328
concat
▸ concat(...collections
): Collection
<string
, Utility
>
Parameters
Name | Type | Description |
---|---|---|
...collections | ReadonlyCollection <string , Utility >[] |
Returns
Collection
<string
, Utility
>
Inherited from
Store.concat
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:338
construct
▸ construct(Ctor
, data
): Utility
Parameters
Name | Type | Description |
---|---|---|
Ctor | ILoaderResultEntry <Utility > | |
data | HydratedModuleData |
Returns
Inherited from
Store.construct
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:348
delete
▸ delete(key
): boolean
Parameters
Name | Type |
---|---|
key | string |
Returns
boolean
Inherited from
Store.delete
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:27
difference
▸ difference<T
>(other
): Collection
<string
, Utility
| T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
other | ReadonlyCollection <string , T > |
Returns
Collection
<string
, Utility
| T
>
Inherited from
Store.difference
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:378
each
▸ each(fn
): UtilitiesStore
Parameters
Name | Type | Description |
---|---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => void |
Returns
Inherited from
Store.each
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:303
▸ each<T
>(fn
, thisArg
): UtilitiesStore
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
fn | (this : T , value : Utility , key : string , collection : UtilitiesStore ) => void |
thisArg | T |
Returns
Inherited from
Store.each
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:304
ensure
▸ ensure(key
, defaultValueGenerator
): Utility
Parameters
Name | Type | Description |
---|---|---|
key | string | |
defaultValueGenerator | (key : string , collection : UtilitiesStore ) => Utility |
Returns
Inherited from
Store.ensure
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:41
entries
▸ entries(): IterableIterator
<[string
, Utility
]>
Returns
IterableIterator
<[string
, Utility
]>
Inherited from
Store.entries
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:126
equals
▸ equals(collection
): boolean
Parameters
Name | Type | Description |
---|---|---|
collection | ReadonlyCollection <string , Utility > |
Returns
boolean
Inherited from
Store.equals
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:347
every
▸ every<K2
>(fn
): this is Collection<K2, Utility>
Type parameters
Name | Type |
---|---|
K2 | extends string |
Parameters
Name | Type | Description |
---|---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => key is K2 |
Returns
this is Collection<K2, Utility>
Inherited from
Store.every
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:269
▸ every<V2
>(fn
): this is Collection<string, V2>
Type parameters
Name | Type |
---|---|
V2 | extends Utility <V2 > |
Parameters
Name | Type |
---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => value is V2 |
Returns
this is Collection<string, V2>
Inherited from
Store.every
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:270
▸ every(fn
): boolean
Parameters
Name | Type |
---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => unknown |
Returns
boolean
Inherited from
Store.every
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:271
▸ every<This
, K2
>(fn
, thisArg
): this is Collection<K2, Utility>
Type parameters
Name | Type |
---|---|
This | This |
K2 | extends string |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => key is K2 |
thisArg | This |
Returns
this is Collection<K2, Utility>
Inherited from
Store.every
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:272
▸ every<This
, V2
>(fn
, thisArg
): this is Collection<string, V2>
Type parameters
Name | Type |
---|---|
This | This |
V2 | extends Utility <V2 > |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => value is V2 |
thisArg | This |
Returns
this is Collection<string, V2>
Inherited from
Store.every
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:273
▸ every<This
>(fn
, thisArg
): boolean
Type parameters
Name |
---|
This |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => unknown |
thisArg | This |
Returns
boolean
Inherited from
Store.every
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:274
filter
▸ filter<K2
>(fn
): Collection
<K2
, Utility
>
Type parameters
Name | Type |
---|---|
K2 | extends string |
Parameters
Name | Type | Description |
---|---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => key is K2 |
Returns
Collection
<K2
, Utility
>
Inherited from
Store.filter
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:183
▸ filter<V2
>(fn
): Collection
<string
, V2
>
Type parameters
Name | Type |
---|---|
V2 | extends Utility <V2 > |
Parameters
Name | Type |
---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => value is V2 |
Returns
Collection
<string
, V2
>
Inherited from
Store.filter
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:184
▸ filter(fn
): Collection
<string
, Utility
>
Parameters
Name | Type |
---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => unknown |
Returns
Collection
<string
, Utility
>
Inherited from
Store.filter
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:185
▸ filter<This
, K2
>(fn
, thisArg
): Collection
<K2
, Utility
>
Type parameters
Name | Type |
---|---|
This | This |
K2 | extends string |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => key is K2 |
thisArg | This |
Returns
Collection
<K2
, Utility
>
Inherited from
Store.filter
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:186
▸ filter<This
, V2
>(fn
, thisArg
): Collection
<string
, V2
>
Type parameters
Name | Type |
---|---|
This | This |
V2 | extends Utility <V2 > |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => value is V2 |
thisArg | This |
Returns
Collection
<string
, V2
>
Inherited from
Store.filter
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:187
▸ filter<This
>(fn
, thisArg
): Collection
<string
, Utility
>
Type parameters
Name |
---|
This |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => unknown |
thisArg | This |
Returns
Collection
<string
, Utility
>
Inherited from
Store.filter
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:188
find
▸ find<V2
>(fn
): undefined
| V2
Type parameters
Name | Type |
---|---|
V2 | extends Utility <V2 > |
Parameters
Name | Type | Description |
---|---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => value is V2 |
Returns
undefined
| V2
Inherited from
Store.find
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:142
▸ find(fn
): undefined
| Utility
Parameters
Name | Type |
---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => unknown |
Returns
undefined
| Utility
Inherited from
Store.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 Utility <V2 > |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => value is V2 |
thisArg | This |
Returns
undefined
| V2
Inherited from
Store.find
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:144
▸ find<This
>(fn
, thisArg
): undefined
| Utility
Type parameters
Name |
---|
This |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => unknown |
thisArg | This |
Returns
undefined
| Utility
Inherited from
Store.find
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:145
findKey
▸ findKey<K2
>(fn
): undefined
| K2
Type parameters
Name | Type |
---|---|
K2 | extends string |
Parameters
Name | Type | Description |
---|---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => key is K2 |
Returns
undefined
| K2
Inherited from
Store.findKey
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:158
▸ findKey(fn
): undefined
| string
Parameters
Name | Type |
---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => unknown |
Returns
undefined
| string
Inherited from
Store.findKey
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:159
▸ findKey<This
, K2
>(fn
, thisArg
): undefined
| K2
Type parameters
Name | Type |
---|---|
This | This |
K2 | extends string |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => key is K2 |
thisArg | This |
Returns
undefined
| K2
Inherited from
Store.findKey
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:160
▸ findKey<This
>(fn
, thisArg
): undefined
| string
Type parameters
Name |
---|
This |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => unknown |
thisArg | This |
Returns
undefined
| string
Inherited from
Store.findKey
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:161
first
▸ first(): undefined
| Utility
Returns
undefined
| Utility
Inherited from
Store.first
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:62
▸ first(amount
): Utility
[]
Parameters
Name | Type |
---|---|
amount | number |
Returns
Utility
[]
Inherited from
Store.first
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:63
firstKey
▸ firstKey(): undefined
| string
Returns
undefined
| string
Inherited from
Store.firstKey
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:71
▸ firstKey(amount
): string
[]
Parameters
Name | Type |
---|---|
amount | number |
Returns
string
[]
Inherited from
Store.firstKey
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:72
flatMap
▸ flatMap<T
>(fn
): Collection
<string
, T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => Collection <string , T > |
Returns
Collection
<string
, T
>
Inherited from
Store.flatMap
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:217
▸ flatMap<T
, This
>(fn
, thisArg
): Collection
<string
, T
>
Type parameters
Name |
---|
T |
This |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => Collection <string , T > |
thisArg | This |
Returns
Collection
<string
, T
>
Inherited from
Store.flatMap
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:218
forEach
▸ forEach(callbackfn
, thisArg?
): void
Parameters
Name | Type |
---|---|
callbackfn | (value : Utility , key : string , map : Map <string , Utility >) => void |
thisArg? | any |
Returns
void
Inherited from
Store.forEach
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:31
get
▸ get(key
): undefined
| Utility
Parameters
Name | Type |
---|---|
key | string |
Returns
undefined
| Utility
Inherited from
Store.get
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:36
has
▸ has(key
): boolean
Parameters
Name | Type |
---|---|
key | string |
Returns
boolean
Inherited from
Store.has
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:40
hasAll
▸ hasAll(...keys
): boolean
Parameters
Name | Type | Description |
---|---|---|
...keys | string [] |
Returns
boolean
Inherited from
Store.hasAll
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:48
hasAny
▸ hasAny(...keys
): boolean
Parameters
Name | Type | Description |
---|---|---|
...keys | string [] |
Returns
boolean
Inherited from
Store.hasAny
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:55
insert
▸ insert(piece
): Promise
<Utility
>
Parameters
Name | Type | Description |
---|---|---|
piece | Utility |
Returns
Promise
<Utility
>
Inherited from
Store.insert
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:341
intersect
▸ intersect<T
>(other
): Collection
<string
, T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
other | ReadonlyCollection <string , T > |
Returns
Collection
<string
, T
>
Inherited from
Store.intersect
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:366
keyAt
▸ keyAt(index
): undefined
| string
Parameters
Name | Type | Description |
---|---|---|
index | number |
Returns
undefined
| string
Inherited from
Store.keyAt
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:106
keys
▸ keys(): IterableIterator
<string
>
Returns
IterableIterator
<string
>
Inherited from
Store.keys
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:131
last
▸ last(): undefined
| Utility
Returns
undefined
| Utility
Inherited from
Store.last
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:80
▸ last(amount
): Utility
[]
Parameters
Name | Type |
---|---|
amount | number |
Returns
Utility
[]
Inherited from
Store.last
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:81
lastKey
▸ lastKey(): undefined
| string
Returns
undefined
| string
Inherited from
Store.lastKey
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:89
▸ lastKey(amount
): string
[]
Parameters
Name | Type |
---|---|
amount | number |
Returns
string
[]
Inherited from
Store.lastKey
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:90
load
▸ load(root
, path
): Promise
<Utility
[]>
Parameters
Name | Type | Description |
---|---|---|
root | string | |
path | string |
Returns
Promise
<Utility
[]>
Inherited from
Store.load
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:315
loadAll
▸ loadAll(): Promise
<void
>
Returns
Promise
<void
>
Inherited from
Store.loadAll
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:329
map
▸ map<T
>(fn
): T
[]
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => T |
Returns
T
[]
Inherited from
Store.map
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:230
▸ map<This
, T
>(fn
, thisArg
): T
[]
Type parameters
Name |
---|
This |
T |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => T |
thisArg | This |
Returns
T
[]
Inherited from
Store.map
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:231
mapValues
▸ mapValues<T
>(fn
): Collection
<string
, T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => T |
Returns
Collection
<string
, T
>
Inherited from
Store.mapValues
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:243
▸ mapValues<This
, T
>(fn
, thisArg
): Collection
<string
, T
>
Type parameters
Name |
---|
This |
T |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => T |
thisArg | This |
Returns
Collection
<string
, T
>
Inherited from
Store.mapValues
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:244
merge
▸ merge<T
, R
>(other
, whenInSelf
, whenInOther
, whenInBoth
): Collection
<string
, R
>
Type parameters
Name |
---|
T |
R |
Parameters
Name | Type | Description |
---|---|---|
other | ReadonlyCollection <string , T > | |
whenInSelf | (value : Utility , key : string ) => Keep <R > | |
whenInOther | (valueOther : T , key : string ) => Keep <R > | |
whenInBoth | (value : Utility , valueOther : T , key : string ) => Keep <R > |
Returns
Collection
<string
, R
>
Inherited from
Store.merge
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:407
partition
▸ partition<K2
>(fn
): [Collection
<K2
, Utility
>, Collection
<Exclude
<string
, K2
>, Utility
>]
Type parameters
Name | Type |
---|---|
K2 | extends string |
Parameters
Name | Type | Description |
---|---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => key is K2 |
Returns
[Collection
<K2
, Utility
>, Collection
<Exclude
<string
, K2
>, Utility
>]
Inherited from
Store.partition
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:200
▸ partition<V2
>(fn
): [Collection
<string
, V2
>, Collection
<string
, Exclude
<Utility
, V2
>>]
Type parameters
Name | Type |
---|---|
V2 | extends Utility <V2 > |
Parameters
Name | Type |
---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => value is V2 |
Returns
[Collection
<string
, V2
>, Collection
<string
, Exclude
<Utility
, V2
>>]
Inherited from
Store.partition
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:201
▸ partition(fn
): [Collection
<string
, Utility
>, Collection
<string
, Utility
>]
Parameters
Name | Type |
---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => unknown |
Returns
[Collection
<string
, Utility
>, Collection
<string
, Utility
>]
Inherited from
Store.partition
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:202
▸ partition<This
, K2
>(fn
, thisArg
): [Collection
<K2
, Utility
>, Collection
<Exclude
<string
, K2
>, Utility
>]
Type parameters
Name | Type |
---|---|
This | This |
K2 | extends string |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => key is K2 |
thisArg | This |
Returns
[Collection
<K2
, Utility
>, Collection
<Exclude
<string
, K2
>, Utility
>]
Inherited from
Store.partition
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:203
▸ partition<This
, V2
>(fn
, thisArg
): [Collection
<string
, V2
>, Collection
<string
, Exclude
<Utility
, V2
>>]
Type parameters
Name | Type |
---|---|
This | This |
V2 | extends Utility <V2 > |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => value is V2 |
thisArg | This |
Returns
[Collection
<string
, V2
>, Collection
<string
, Exclude
<Utility
, V2
>>]
Inherited from
Store.partition
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:204
▸ partition<This
>(fn
, thisArg
): [Collection
<string
, Utility
>, Collection
<string
, Utility
>]
Type parameters
Name |
---|
This |
Parameters
Name | Type |
---|---|
fn | (this : This , value : Utility , key : string , collection : UtilitiesStore ) => unknown |
thisArg | This |
Returns
[Collection
<string
, Utility
>, Collection
<string
, Utility
>]
Inherited from
Store.partition
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:205
random
▸ random(): undefined
| Utility
Returns
undefined
| Utility
Inherited from
Store.random
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:113
▸ random(amount
): Utility
[]
Parameters
Name | Type |
---|---|
amount | number |
Returns
Utility
[]
Inherited from
Store.random
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:114
randomKey
▸ randomKey(): undefined
| string
Returns
undefined
| string
Inherited from
Store.randomKey
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:121
▸ randomKey(amount
): string
[]
Parameters
Name | Type |
---|---|
amount | number |
Returns
string
[]
Inherited from
Store.randomKey
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:122
reduce
▸ reduce<T
>(fn
, initialValue?
): T
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
fn | (accumulator : T , value : Utility , key : string , collection : UtilitiesStore ) => T | |
initialValue? | T |
Returns
T
Inherited from
Store.reduce
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:287
registerPath
▸ registerPath(path
): UtilitiesStore
Parameters
Name | Type | Description |
---|---|---|
path | Path |
Returns
Inherited from
Store.registerPath
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:308
resolve
▸ resolve(name
): Utility
Parameters
Name | Type | Description |
---|---|---|
name | string | Utility |
Returns
Inherited from
Store.resolve
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:335
reverse
▸ reverse(): UtilitiesStore
Returns
Inherited from
Store.reverse
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:127
set
▸ set(key
, value
): UtilitiesStore
Parameters
Name | Type |
---|---|
key | string |
value | Utility |
Returns
Inherited from
Store.set
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:44
some
▸ some(fn
): boolean
Parameters
Name | Type | Description |
---|---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => unknown |
Returns
boolean
Inherited from
Store.some
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:256
▸ some<T
>(fn
, thisArg
): boolean
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
fn | (this : T , value : Utility , key : string , collection : UtilitiesStore ) => unknown |
thisArg | T |
Returns
boolean
Inherited from
Store.some
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:257
sort
▸ sort(compareFunction?
): UtilitiesStore
Parameters
Name | Type | Description |
---|---|---|
compareFunction? | Comparator <string , Utility > |
Returns
Inherited from
Store.sort
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:360
sorted
▸ sorted(compareFunction?
): Collection
<string
, Utility
>
Parameters
Name | Type | Description |
---|---|---|
compareFunction? | Comparator <string , Utility > |
Returns
Collection
<string
, Utility
>
Inherited from
Store.sorted
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:421
subtract
▸ subtract<T
>(other
): Collection
<string
, Utility
>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
other | ReadonlyCollection <string , T > |
Returns
Collection
<string
, Utility
>
Inherited from
Store.subtract
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:372
sweep
▸ sweep(fn
): number
Parameters
Name | Type | Description |
---|---|---|
fn | (value : Utility , key : string , collection : UtilitiesStore ) => unknown |
Returns
number
Inherited from
Store.sweep
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:169
▸ sweep<T
>(fn
, thisArg
): number
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
fn | (this : T , value : Utility , key : string , collection : UtilitiesStore ) => unknown |
thisArg | T |
Returns
number
Inherited from
Store.sweep
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:170
tap
▸ tap(fn
): UtilitiesStore
Parameters
Name | Type | Description |
---|---|---|
fn | (collection : UtilitiesStore ) => void |
Returns
Inherited from
Store.tap
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:318
▸ tap<T
>(fn
, thisArg
): UtilitiesStore
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
fn | (this : T , collection : UtilitiesStore ) => void |
thisArg | T |
Returns
Inherited from
Store.tap
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:319
toJSON
▸ toJSON(): Utility
[]
Returns
Utility
[]
Inherited from
Store.toJSON
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:422
unload
▸ unload(name
): Promise
<Utility
>
Parameters
Name | Type | Description |
---|---|---|
name | string | Utility |
Returns
Promise
<Utility
>
Inherited from
Store.unload
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:321
unloadAll
▸ unloadAll(): Promise
<Utility
[]>
Returns
Promise
<Utility
[]>
Inherited from
Store.unloadAll
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:325
values
▸ values(): IterableIterator
<Utility
>
Returns
IterableIterator
<Utility
>
Inherited from
Store.values
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:136
combineEntries
▸ Static
combineEntries<K
, V
>(entries
, combine
): Collection
<K
, V
>
Type parameters
Name |
---|
K |
V |
Parameters
Name | Type | Description |
---|---|---|
entries | Iterable <[K , V ]> | |
combine | (firstValue : V , secondValue : V , key : K ) => V |
Returns
Collection
<K
, V
>
Inherited from
Store.combineEntries
Defined in
node_modules/@discordjs/collection/dist/index.d.ts:435