Skip to main content

Class: ArgumentStore

Hierarchy

Constructors

constructor

new ArgumentStore()

Overrides

AliasStore.constructor

Defined in

projects/framework/src/lib/structures/ArgumentStore.ts:5

Properties

Constructor

Readonly Constructor: AbstractConstructor<Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.Constructor

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:284


[toStringTag]

Readonly [toStringTag]: string

Inherited from

AliasStore.[toStringTag]

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:135


aliases

Readonly aliases: Collection<string, Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.aliases

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:709


constructor

constructor: CollectionConstructor

Inherited from

AliasStore.constructor

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:21


name

Readonly name: string

Inherited from

AliasStore.name

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:285


paths

Readonly paths: Set<string>

Inherited from

AliasStore.paths

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:286


size

Readonly size: number

Inherited from

AliasStore.size

Defined in

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


strategy

Readonly strategy: ILoaderStrategy<Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.strategy

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:287


[species]

Static Readonly [species]: MapConstructor

Inherited from

AliasStore.[species]

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:317


defaultStrategy

Static defaultStrategy: ILoaderStrategy<any>

Inherited from

AliasStore.defaultStrategy

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:372


logger

Static logger: null | StoreLogger

Inherited from

AliasStore.logger

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:376

Accessors

container

get container(): Container

Returns

Container

Inherited from

AliasStore.container

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:297

Methods

[iterator]

[iterator](): IterableIterator<[string, Argument<unknown, ArgumentOptions>]>

Returns

IterableIterator<[string, Argument<unknown, ArgumentOptions>]>

Inherited from

AliasStore.[iterator]

Defined in

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


at

at(index): undefined | Argument<unknown, ArgumentOptions>

Parameters

NameTypeDescription
indexnumber

Returns

undefined | Argument<unknown, ArgumentOptions>

Inherited from

AliasStore.at

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:105


clear

clear(): void

Returns

void

Inherited from

AliasStore.clear

Defined in

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


clone

clone(): Collection<string, Argument<unknown, ArgumentOptions>>

Returns

Collection<string, Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.clone

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:350


concat

concat(...collections): Collection<string, Argument<unknown, ArgumentOptions>>

Parameters

NameTypeDescription
...collectionsReadonlyCollection<string, Argument<unknown, ArgumentOptions>>[]

Returns

Collection<string, Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.concat

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:361


construct

construct(Ctor, data): Argument<unknown, ArgumentOptions>

Parameters

NameTypeDescription
CtorILoaderResultEntry<Argument<unknown, ArgumentOptions>>
dataHydratedModuleData

Returns

Argument<unknown, ArgumentOptions>

Inherited from

AliasStore.construct

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:348


delete

delete(key): boolean

Parameters

NameType
keystring

Returns

boolean

Inherited from

AliasStore.delete

Defined in

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


difference

difference<T>(other): Collection<string, Argument<unknown, ArgumentOptions> | T>

Type parameters

Name
T

Parameters

NameTypeDescription
otherReadonlyCollection<string, T>

Returns

Collection<string, Argument<unknown, ArgumentOptions> | T>

Inherited from

AliasStore.difference

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:397


each

each(fn): ArgumentStore

Parameters

NameTypeDescription
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => void

Returns

ArgumentStore

Inherited from

AliasStore.each

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:324

each<T>(fn, thisArg): ArgumentStore

Type parameters

Name
T

Parameters

NameType
fn(this: T, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => void
thisArgT

Returns

ArgumentStore

Inherited from

AliasStore.each

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:325


ensure

ensure(key, defaultValueGenerator): Argument<unknown, ArgumentOptions>

Parameters

NameTypeDescription
keystring
defaultValueGenerator(key: string, collection: ArgumentStore) => Argument<unknown, ArgumentOptions>

Returns

Argument<unknown, ArgumentOptions>

Inherited from

AliasStore.ensure

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:42


entries

entries(): IterableIterator<[string, Argument<unknown, ArgumentOptions>]>

Returns

IterableIterator<[string, Argument<unknown, ArgumentOptions>]>

Inherited from

AliasStore.entries

Defined in

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


equals

equals(collection): boolean

Parameters

NameTypeDescription
collectionReadonlyCollection<string, Argument<unknown, ArgumentOptions>>

Returns

boolean

Inherited from

AliasStore.equals

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:371


every

every<K2>(fn): this is Collection<K2, Argument<unknown, ArgumentOptions>>

Type parameters

NameType
K2extends string

Parameters

NameTypeDescription
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => key is K2

Returns

this is Collection<K2, Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.every

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:288

every<V2>(fn): this is Collection<string, V2>

Type parameters

NameType
V2extends Argument<unknown, ArgumentOptions, V2>

Parameters

NameType
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => value is V2

Returns

this is Collection<string, V2>

Inherited from

AliasStore.every

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:289

every(fn): boolean

Parameters

NameType
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean

Returns

boolean

Inherited from

AliasStore.every

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:290

every<This, K2>(fn, thisArg): this is Collection<K2, Argument<unknown, ArgumentOptions>>

Type parameters

NameType
ThisThis
K2extends string

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => key is K2
thisArgThis

Returns

this is Collection<K2, Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.every

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:291

every<This, V2>(fn, thisArg): this is Collection<string, V2>

Type parameters

NameType
ThisThis
V2extends Argument<unknown, ArgumentOptions, V2>

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => value is V2
thisArgThis

Returns

this is Collection<string, V2>

Inherited from

AliasStore.every

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:292

every<This>(fn, thisArg): boolean

Type parameters

Name
This

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean
thisArgThis

Returns

boolean

Inherited from

AliasStore.every

Defined in

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


filter

filter<K2>(fn): Collection<K2, Argument<unknown, ArgumentOptions>>

Type parameters

NameType
K2extends string

Parameters

NameTypeDescription
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => key is K2

Returns

Collection<K2, Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.filter

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:196

filter<V2>(fn): Collection<string, V2>

Type parameters

NameType
V2extends Argument<unknown, ArgumentOptions, V2>

Parameters

NameType
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => value is V2

Returns

Collection<string, V2>

Inherited from

AliasStore.filter

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:197

filter(fn): Collection<string, Argument<unknown, ArgumentOptions>>

Parameters

NameType
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean

Returns

Collection<string, Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.filter

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:198

filter<This, K2>(fn, thisArg): Collection<K2, Argument<unknown, ArgumentOptions>>

Type parameters

NameType
ThisThis
K2extends string

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => key is K2
thisArgThis

Returns

Collection<K2, Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.filter

Defined in

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

filter<This, V2>(fn, thisArg): Collection<string, V2>

Type parameters

NameType
ThisThis
V2extends Argument<unknown, ArgumentOptions, V2>

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => value is V2
thisArgThis

Returns

Collection<string, V2>

Inherited from

AliasStore.filter

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:200

filter<This>(fn, thisArg): Collection<string, Argument<unknown, ArgumentOptions>>

Type parameters

Name
This

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean
thisArgThis

Returns

Collection<string, Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.filter

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:201


find

find<V2>(fn): undefined | V2

Type parameters

NameType
V2extends Argument<unknown, ArgumentOptions, V2>

Parameters

NameTypeDescription
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => value is V2

Returns

undefined | V2

Inherited from

AliasStore.find

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:152

find(fn): undefined | Argument<unknown, ArgumentOptions>

Parameters

NameType
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean

Returns

undefined | Argument<unknown, ArgumentOptions>

Inherited from

AliasStore.find

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:153

find<This, V2>(fn, thisArg): undefined | V2

Type parameters

NameType
ThisThis
V2extends Argument<unknown, ArgumentOptions, V2>

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => value is V2
thisArgThis

Returns

undefined | V2

Inherited from

AliasStore.find

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:154

find<This>(fn, thisArg): undefined | Argument<unknown, ArgumentOptions>

Type parameters

Name
This

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean
thisArgThis

Returns

undefined | Argument<unknown, ArgumentOptions>

Inherited from

AliasStore.find

Defined in

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


findKey

findKey<K2>(fn): undefined | K2

Type parameters

NameType
K2extends string

Parameters

NameTypeDescription
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => key is K2

Returns

undefined | K2

Inherited from

AliasStore.findKey

Defined in

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

findKey(fn): undefined | string

Parameters

NameType
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean

Returns

undefined | string

Inherited from

AliasStore.findKey

Defined in

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

findKey<This, K2>(fn, thisArg): undefined | K2

Type parameters

NameType
ThisThis
K2extends string

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => key is K2
thisArgThis

Returns

undefined | K2

Inherited from

AliasStore.findKey

Defined in

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

findKey<This>(fn, thisArg): undefined | string

Type parameters

Name
This

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean
thisArgThis

Returns

undefined | string

Inherited from

AliasStore.findKey

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:172


first

first(): undefined | Argument<unknown, ArgumentOptions>

Returns

undefined | Argument<unknown, ArgumentOptions>

Inherited from

AliasStore.first

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:66

first(amount): Argument<unknown, ArgumentOptions>[]

Parameters

NameType
amountnumber

Returns

Argument<unknown, ArgumentOptions>[]

Inherited from

AliasStore.first

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:67


firstKey

firstKey(): undefined | string

Returns

undefined | string

Inherited from

AliasStore.firstKey

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:76

firstKey(amount): string[]

Parameters

NameType
amountnumber

Returns

string[]

Inherited from

AliasStore.firstKey

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:77


flatMap

flatMap<T>(fn): Collection<string, T>

Type parameters

Name
T

Parameters

NameTypeDescription
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => Collection<string, T>

Returns

Collection<string, T>

Inherited from

AliasStore.flatMap

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:232

flatMap<T, This>(fn, thisArg): Collection<string, T>

Type parameters

Name
T
This

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => Collection<string, T>
thisArgThis

Returns

Collection<string, T>

Inherited from

AliasStore.flatMap

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:233


forEach

forEach(callbackfn, thisArg?): void

Parameters

NameType
callbackfn(value: Argument<unknown, ArgumentOptions>, key: string, map: Map<string, Argument<unknown, ArgumentOptions>>) => void
thisArg?any

Returns

void

Inherited from

AliasStore.forEach

Defined in

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


get

get(key): undefined | Argument<unknown, ArgumentOptions>

Parameters

NameTypeDescription
keystring

Returns

undefined | Argument<unknown, ArgumentOptions>

Inherited from

AliasStore.get

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:714


has

has(key): boolean

Parameters

NameTypeDescription
keystring

Returns

boolean

Inherited from

AliasStore.has

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:719


hasAll

hasAll(...keys): boolean

Parameters

NameTypeDescription
...keysstring[]

Returns

boolean

Inherited from

AliasStore.hasAll

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:50


hasAny

hasAny(...keys): boolean

Parameters

NameTypeDescription
...keysstring[]

Returns

boolean

Inherited from

AliasStore.hasAny

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:58


insert

insert(piece): Promise<Argument<unknown, ArgumentOptions>>

Parameters

NameTypeDescription
pieceArgument<unknown, ArgumentOptions>

Returns

Promise<Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.insert

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:731


intersect

intersect<T>(other): Collection<string, T>

Type parameters

Name
T

Parameters

NameTypeDescription
otherReadonlyCollection<string, T>

Returns

Collection<string, T>

Inherited from

AliasStore.intersect

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:391


keyAt

keyAt(index): undefined | string

Parameters

NameTypeDescription
indexnumber

Returns

undefined | string

Inherited from

AliasStore.keyAt

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:113


keys

keys(): IterableIterator<string>

Returns

IterableIterator<string>

Inherited from

AliasStore.keys

Defined in

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


last

last(): undefined | Argument<unknown, ArgumentOptions>

Returns

undefined | Argument<unknown, ArgumentOptions>

Inherited from

AliasStore.last

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:86

last(amount): Argument<unknown, ArgumentOptions>[]

Parameters

NameType
amountnumber

Returns

Argument<unknown, ArgumentOptions>[]

Inherited from

AliasStore.last

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:87


lastKey

lastKey(): undefined | string

Returns

undefined | string

Inherited from

AliasStore.lastKey

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:96

lastKey(amount): string[]

Parameters

NameType
amountnumber

Returns

string[]

Inherited from

AliasStore.lastKey

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:97


load

load(root, path): Promise<Argument<unknown, ArgumentOptions>[]>

Parameters

NameTypeDescription
rootstring
pathstring

Returns

Promise<Argument<unknown, ArgumentOptions>[]>

Inherited from

AliasStore.load

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:315


loadAll

loadAll(): Promise<void>

Returns

Promise<void>

Inherited from

AliasStore.loadAll

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:329


map

map<T>(fn): T[]

Type parameters

Name
T

Parameters

NameTypeDescription
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => T

Returns

T[]

Inherited from

AliasStore.map

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:246

map<This, T>(fn, thisArg): T[]

Type parameters

Name
This
T

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => T
thisArgThis

Returns

T[]

Inherited from

AliasStore.map

Defined in

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


mapValues

mapValues<T>(fn): Collection<string, T>

Type parameters

Name
T

Parameters

NameTypeDescription
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => T

Returns

Collection<string, T>

Inherited from

AliasStore.mapValues

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:260

mapValues<This, T>(fn, thisArg): Collection<string, T>

Type parameters

Name
This
T

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => T
thisArgThis

Returns

Collection<string, T>

Inherited from

AliasStore.mapValues

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:261


merge

merge<T, R>(other, whenInSelf, whenInOther, whenInBoth): Collection<string, R>

Type parameters

Name
T
R

Parameters

NameTypeDescription
otherReadonlyCollection<string, T>
whenInSelf(value: Argument<unknown, ArgumentOptions>, key: string) => Keep<R>
whenInOther(valueOther: T, key: string) => Keep<R>
whenInBoth(value: Argument<unknown, ArgumentOptions>, valueOther: T, key: string) => Keep<R>

Returns

Collection<string, R>

Inherited from

AliasStore.merge

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:427


partition

partition<K2>(fn): [Collection<K2, Argument<unknown, ArgumentOptions>>, Collection<Exclude<string, K2>, Argument<unknown, ArgumentOptions>>]

Type parameters

NameType
K2extends string

Parameters

NameTypeDescription
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => key is K2

Returns

[Collection<K2, Argument<unknown, ArgumentOptions>>, Collection<Exclude<string, K2>, Argument<unknown, ArgumentOptions>>]

Inherited from

AliasStore.partition

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:214

partition<V2>(fn): [Collection<string, V2>, Collection<string, Exclude<Argument<unknown, ArgumentOptions>, V2>>]

Type parameters

NameType
V2extends Argument<unknown, ArgumentOptions, V2>

Parameters

NameType
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => value is V2

Returns

[Collection<string, V2>, Collection<string, Exclude<Argument<unknown, ArgumentOptions>, V2>>]

Inherited from

AliasStore.partition

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:215

partition(fn): [Collection<string, Argument<unknown, ArgumentOptions>>, Collection<string, Argument<unknown, ArgumentOptions>>]

Parameters

NameType
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean

Returns

[Collection<string, Argument<unknown, ArgumentOptions>>, Collection<string, Argument<unknown, ArgumentOptions>>]

Inherited from

AliasStore.partition

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:216

partition<This, K2>(fn, thisArg): [Collection<K2, Argument<unknown, ArgumentOptions>>, Collection<Exclude<string, K2>, Argument<unknown, ArgumentOptions>>]

Type parameters

NameType
ThisThis
K2extends string

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => key is K2
thisArgThis

Returns

[Collection<K2, Argument<unknown, ArgumentOptions>>, Collection<Exclude<string, K2>, Argument<unknown, ArgumentOptions>>]

Inherited from

AliasStore.partition

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:217

partition<This, V2>(fn, thisArg): [Collection<string, V2>, Collection<string, Exclude<Argument<unknown, ArgumentOptions>, V2>>]

Type parameters

NameType
ThisThis
V2extends Argument<unknown, ArgumentOptions, V2>

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => value is V2
thisArgThis

Returns

[Collection<string, V2>, Collection<string, Exclude<Argument<unknown, ArgumentOptions>, V2>>]

Inherited from

AliasStore.partition

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:218

partition<This>(fn, thisArg): [Collection<string, Argument<unknown, ArgumentOptions>>, Collection<string, Argument<unknown, ArgumentOptions>>]

Type parameters

Name
This

Parameters

NameType
fn(this: This, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean
thisArgThis

Returns

[Collection<string, Argument<unknown, ArgumentOptions>>, Collection<string, Argument<unknown, ArgumentOptions>>]

Inherited from

AliasStore.partition

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:219


random

random(): undefined | Argument<unknown, ArgumentOptions>

Returns

undefined | Argument<unknown, ArgumentOptions>

Inherited from

AliasStore.random

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:121

random(amount): Argument<unknown, ArgumentOptions>[]

Parameters

NameType
amountnumber

Returns

Argument<unknown, ArgumentOptions>[]

Inherited from

AliasStore.random

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:122


randomKey

randomKey(): undefined | string

Returns

undefined | string

Inherited from

AliasStore.randomKey

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:130

randomKey(amount): string[]

Parameters

NameType
amountnumber

Returns

string[]

Inherited from

AliasStore.randomKey

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:131


reduce

reduce<T>(fn, initialValue?): T

Type parameters

Name
T

Parameters

NameTypeDescription
fn(accumulator: T, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => T
initialValue?T

Returns

T

Inherited from

AliasStore.reduce

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:307


registerPath

registerPath(path): ArgumentStore

Parameters

NameTypeDescription
pathPath

Returns

ArgumentStore

Inherited from

AliasStore.registerPath

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:308


resolve

resolve(name): Argument<unknown, ArgumentOptions>

Parameters

NameTypeDescription
namestring | Argument<unknown, ArgumentOptions>

Returns

Argument<unknown, ArgumentOptions>

Inherited from

AliasStore.resolve

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:335


reverse

reverse(): ArgumentStore

Returns

ArgumentStore

Inherited from

AliasStore.reverse

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:136


set

set(key, value): ArgumentStore

Parameters

NameType
keystring
valueArgument<unknown, ArgumentOptions>

Returns

ArgumentStore

Inherited from

AliasStore.set

Defined in

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


some

some(fn): boolean

Parameters

NameTypeDescription
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean

Returns

boolean

Inherited from

AliasStore.some

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:274

some<T>(fn, thisArg): boolean

Type parameters

Name
T

Parameters

NameType
fn(this: T, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean
thisArgT

Returns

boolean

Inherited from

AliasStore.some

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:275


sort

sort(compareFunction?): ArgumentStore

Parameters

NameTypeDescription
compareFunction?Comparator<string, Argument<unknown, ArgumentOptions>>

Returns

ArgumentStore

Inherited from

AliasStore.sort

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:385


sorted

sorted(compareFunction?): Collection<string, Argument<unknown, ArgumentOptions>>

Parameters

NameTypeDescription
compareFunction?Comparator<string, Argument<unknown, ArgumentOptions>>

Returns

Collection<string, Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.sorted

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:442


sweep

sweep(fn): number

Parameters

NameTypeDescription
fn(value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean

Returns

number

Inherited from

AliasStore.sweep

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:181

sweep<T>(fn, thisArg): number

Type parameters

Name
T

Parameters

NameType
fn(this: T, value: Argument<unknown, ArgumentOptions>, key: string, collection: ArgumentStore) => boolean
thisArgT

Returns

number

Inherited from

AliasStore.sweep

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:182


tap

tap(fn): ArgumentStore

Parameters

NameTypeDescription
fn(collection: ArgumentStore) => void

Returns

ArgumentStore

Inherited from

AliasStore.tap

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:340

tap<T>(fn, thisArg): ArgumentStore

Type parameters

Name
T

Parameters

NameType
fn(this: T, collection: ArgumentStore) => void
thisArgT

Returns

ArgumentStore

Inherited from

AliasStore.tap

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:341


toJSON

toJSON(): Argument<unknown, ArgumentOptions>[]

Returns

Argument<unknown, ArgumentOptions>[]

Inherited from

AliasStore.toJSON

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:443


unload

unload(name): Promise<Argument<unknown, ArgumentOptions>>

Parameters

NameTypeDescription
namestring | Argument<unknown, ArgumentOptions>

Returns

Promise<Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.unload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:725


unloadAll

unloadAll(): Promise<Argument<unknown, ArgumentOptions>[]>

Returns

Promise<Argument<unknown, ArgumentOptions>[]>

Inherited from

AliasStore.unloadAll

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:325


values

values(): IterableIterator<Argument<unknown, ArgumentOptions>>

Returns

IterableIterator<Argument<unknown, ArgumentOptions>>

Inherited from

AliasStore.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

NameTypeDescription
entriesIterable<[K, V]>
combine(firstValue: V, secondValue: V, key: K) => V

Returns

Collection<K, V>

Inherited from

AliasStore.combineEntries

Defined in

node_modules/@discordjs/collection/dist/collection.d.ts:457