Skip to main content

Class: ListenerStore

Hierarchy

Constructors

constructor

new ListenerStore()

Overrides

Store.constructor

Defined in

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

Properties

Constructor

Readonly Constructor: AbstractConstructor<Listener<"", ListenerOptions>>

Inherited from

Store.Constructor

Defined in

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


[toStringTag]

Readonly [toStringTag]: string

Inherited from

Store.[toStringTag]

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/collection.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:28


strategy

Readonly strategy: ILoaderStrategy<Listener<"", ListenerOptions>>

Inherited from

Store.strategy

Defined in

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


[species]

Static Readonly [species]: MapConstructor

Inherited from

Store.[species]

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, Listener<"", ListenerOptions>]>

Returns

IterableIterator<[string, Listener<"", ListenerOptions>]>

Inherited from

Store.[iterator]

Defined in

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


at

at(index): undefined | Listener<"", ListenerOptions>

Parameters

NameTypeDescription
indexnumber

Returns

undefined | Listener<"", ListenerOptions>

Inherited from

Store.at

Defined in

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


clear

clear(): void

Returns

void

Inherited from

Store.clear

Defined in

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


clone

clone(): Collection<string, Listener<"", ListenerOptions>>

Returns

Collection<string, Listener<"", ListenerOptions>>

Inherited from

Store.clone

Defined in

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


concat

concat(...collections): Collection<string, Listener<"", ListenerOptions>>

Parameters

NameTypeDescription
...collectionsReadonlyCollection<string, Listener<"", ListenerOptions>>[]

Returns

Collection<string, Listener<"", ListenerOptions>>

Inherited from

Store.concat

Defined in

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


construct

construct(Ctor, data): Listener<"", ListenerOptions>

Parameters

NameTypeDescription
CtorILoaderResultEntry<Listener<"", ListenerOptions>>
dataHydratedModuleData

Returns

Listener<"", ListenerOptions>

Inherited from

Store.construct

Defined in

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


delete

delete(key): boolean

Parameters

NameType
keystring

Returns

boolean

Inherited from

Store.delete

Defined in

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


difference

difference<T>(other): Collection<string, Listener<"", ListenerOptions> | T>

Type parameters

Name
T

Parameters

NameTypeDescription
otherReadonlyCollection<string, T>

Returns

Collection<string, Listener<"", ListenerOptions> | T>

Inherited from

Store.difference

Defined in

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


each

each(fn): ListenerStore

Parameters

NameTypeDescription
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => void

Returns

ListenerStore

Inherited from

Store.each

Defined in

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

each<T>(fn, thisArg): ListenerStore

Type parameters

Name
T

Parameters

NameType
fn(this: T, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => void
thisArgT

Returns

ListenerStore

Inherited from

Store.each

Defined in

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


ensure

ensure(key, defaultValueGenerator): Listener<"", ListenerOptions>

Parameters

NameTypeDescription
keystring
defaultValueGenerator(key: string, collection: ListenerStore) => Listener<"", ListenerOptions>

Returns

Listener<"", ListenerOptions>

Inherited from

Store.ensure

Defined in

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


entries

entries(): IterableIterator<[string, Listener<"", ListenerOptions>]>

Returns

IterableIterator<[string, Listener<"", ListenerOptions>]>

Inherited from

Store.entries

Defined in

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


equals

equals(collection): boolean

Parameters

NameTypeDescription
collectionReadonlyCollection<string, Listener<"", ListenerOptions>>

Returns

boolean

Inherited from

Store.equals

Defined in

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


every

every<K2>(fn): this is Collection<K2, Listener<"", ListenerOptions>>

Type parameters

NameType
K2extends string

Parameters

NameTypeDescription
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => key is K2

Returns

this is Collection<K2, Listener<"", ListenerOptions>>

Inherited from

Store.every

Defined in

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

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

Type parameters

NameType
V2extends Listener<"", ListenerOptions, V2>

Parameters

NameType
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => value is V2

Returns

this is Collection<string, V2>

Inherited from

Store.every

Defined in

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

every(fn): boolean

Parameters

NameType
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean

Returns

boolean

Inherited from

Store.every

Defined in

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

every<This, K2>(fn, thisArg): this is Collection<K2, Listener<"", ListenerOptions>>

Type parameters

NameType
ThisThis
K2extends string

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => key is K2
thisArgThis

Returns

this is Collection<K2, Listener<"", ListenerOptions>>

Inherited from

Store.every

Defined in

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

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

Type parameters

NameType
ThisThis
V2extends Listener<"", ListenerOptions, V2>

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => value is V2
thisArgThis

Returns

this is Collection<string, V2>

Inherited from

Store.every

Defined in

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

every<This>(fn, thisArg): boolean

Type parameters

Name
This

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean
thisArgThis

Returns

boolean

Inherited from

Store.every

Defined in

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


filter

filter<K2>(fn): Collection<K2, Listener<"", ListenerOptions>>

Type parameters

NameType
K2extends string

Parameters

NameTypeDescription
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => key is K2

Returns

Collection<K2, Listener<"", ListenerOptions>>

Inherited from

Store.filter

Defined in

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

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

Type parameters

NameType
V2extends Listener<"", ListenerOptions, V2>

Parameters

NameType
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => value is V2

Returns

Collection<string, V2>

Inherited from

Store.filter

Defined in

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

filter(fn): Collection<string, Listener<"", ListenerOptions>>

Parameters

NameType
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean

Returns

Collection<string, Listener<"", ListenerOptions>>

Inherited from

Store.filter

Defined in

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

filter<This, K2>(fn, thisArg): Collection<K2, Listener<"", ListenerOptions>>

Type parameters

NameType
ThisThis
K2extends string

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => key is K2
thisArgThis

Returns

Collection<K2, Listener<"", ListenerOptions>>

Inherited from

Store.filter

Defined in

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

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

Type parameters

NameType
ThisThis
V2extends Listener<"", ListenerOptions, V2>

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => value is V2
thisArgThis

Returns

Collection<string, V2>

Inherited from

Store.filter

Defined in

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

filter<This>(fn, thisArg): Collection<string, Listener<"", ListenerOptions>>

Type parameters

Name
This

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean
thisArgThis

Returns

Collection<string, Listener<"", ListenerOptions>>

Inherited from

Store.filter

Defined in

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


find

find<V2>(fn): undefined | V2

Type parameters

NameType
V2extends Listener<"", ListenerOptions, V2>

Parameters

NameTypeDescription
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => value is V2

Returns

undefined | V2

Inherited from

Store.find

Defined in

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

find(fn): undefined | Listener<"", ListenerOptions>

Parameters

NameType
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean

Returns

undefined | Listener<"", ListenerOptions>

Inherited from

Store.find

Defined in

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

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

Type parameters

NameType
ThisThis
V2extends Listener<"", ListenerOptions, V2>

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => value is V2
thisArgThis

Returns

undefined | V2

Inherited from

Store.find

Defined in

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

find<This>(fn, thisArg): undefined | Listener<"", ListenerOptions>

Type parameters

Name
This

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean
thisArgThis

Returns

undefined | Listener<"", ListenerOptions>

Inherited from

Store.find

Defined in

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


findKey

findKey<K2>(fn): undefined | K2

Type parameters

NameType
K2extends string

Parameters

NameTypeDescription
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => key is K2

Returns

undefined | K2

Inherited from

Store.findKey

Defined in

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

findKey(fn): undefined | string

Parameters

NameType
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean

Returns

undefined | string

Inherited from

Store.findKey

Defined in

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

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

Type parameters

NameType
ThisThis
K2extends string

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => key is K2
thisArgThis

Returns

undefined | K2

Inherited from

Store.findKey

Defined in

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

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

Type parameters

Name
This

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean
thisArgThis

Returns

undefined | string

Inherited from

Store.findKey

Defined in

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


first

first(): undefined | Listener<"", ListenerOptions>

Returns

undefined | Listener<"", ListenerOptions>

Inherited from

Store.first

Defined in

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

first(amount): Listener<"", ListenerOptions>[]

Parameters

NameType
amountnumber

Returns

Listener<"", ListenerOptions>[]

Inherited from

Store.first

Defined in

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


firstKey

firstKey(): undefined | string

Returns

undefined | string

Inherited from

Store.firstKey

Defined in

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

firstKey(amount): string[]

Parameters

NameType
amountnumber

Returns

string[]

Inherited from

Store.firstKey

Defined in

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


flatMap

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

Type parameters

Name
T

Parameters

NameTypeDescription
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => Collection<string, T>

Returns

Collection<string, T>

Inherited from

Store.flatMap

Defined in

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

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

Type parameters

Name
T
This

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => Collection<string, T>
thisArgThis

Returns

Collection<string, T>

Inherited from

Store.flatMap

Defined in

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


forEach

forEach(callbackfn, thisArg?): void

Parameters

NameType
callbackfn(value: Listener<"", ListenerOptions>, key: string, map: Map<string, Listener<"", ListenerOptions>>) => void
thisArg?any

Returns

void

Inherited from

Store.forEach

Defined in

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


get

get(key): undefined | Listener<"", ListenerOptions>

Parameters

NameType
keystring

Returns

undefined | Listener<"", ListenerOptions>

Inherited from

Store.get

Defined in

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


has

has(key): boolean

Parameters

NameType
keystring

Returns

boolean

Inherited from

Store.has

Defined in

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


hasAll

hasAll(...keys): boolean

Parameters

NameTypeDescription
...keysstring[]

Returns

boolean

Inherited from

Store.hasAll

Defined in

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


hasAny

hasAny(...keys): boolean

Parameters

NameTypeDescription
...keysstring[]

Returns

boolean

Inherited from

Store.hasAny

Defined in

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


insert

insert(piece): Promise<Listener<"", ListenerOptions>>

Parameters

NameTypeDescription
pieceListener<"", ListenerOptions>

Returns

Promise<Listener<"", ListenerOptions>>

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

NameTypeDescription
otherReadonlyCollection<string, T>

Returns

Collection<string, T>

Inherited from

Store.intersect

Defined in

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


keyAt

keyAt(index): undefined | string

Parameters

NameTypeDescription
indexnumber

Returns

undefined | string

Inherited from

Store.keyAt

Defined in

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


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 | Listener<"", ListenerOptions>

Returns

undefined | Listener<"", ListenerOptions>

Inherited from

Store.last

Defined in

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

last(amount): Listener<"", ListenerOptions>[]

Parameters

NameType
amountnumber

Returns

Listener<"", ListenerOptions>[]

Inherited from

Store.last

Defined in

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


lastKey

lastKey(): undefined | string

Returns

undefined | string

Inherited from

Store.lastKey

Defined in

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

lastKey(amount): string[]

Parameters

NameType
amountnumber

Returns

string[]

Inherited from

Store.lastKey

Defined in

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


load

load(root, path): Promise<Listener<"", ListenerOptions>[]>

Parameters

NameTypeDescription
rootstring
pathstring

Returns

Promise<Listener<"", ListenerOptions>[]>

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

NameTypeDescription
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => T

Returns

T[]

Inherited from

Store.map

Defined in

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

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

Type parameters

Name
This
T

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => T
thisArgThis

Returns

T[]

Inherited from

Store.map

Defined in

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


mapValues

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

Type parameters

Name
T

Parameters

NameTypeDescription
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => T

Returns

Collection<string, T>

Inherited from

Store.mapValues

Defined in

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

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

Type parameters

Name
This
T

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => T
thisArgThis

Returns

Collection<string, T>

Inherited from

Store.mapValues

Defined in

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


merge

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

Type parameters

Name
T
R

Parameters

NameTypeDescription
otherReadonlyCollection<string, T>
whenInSelf(value: Listener<"", ListenerOptions>, key: string) => Keep<R>
whenInOther(valueOther: T, key: string) => Keep<R>
whenInBoth(value: Listener<"", ListenerOptions>, valueOther: T, key: string) => Keep<R>

Returns

Collection<string, R>

Inherited from

Store.merge

Defined in

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


partition

partition<K2>(fn): [Collection<K2, Listener<"", ListenerOptions>>, Collection<Exclude<string, K2>, Listener<"", ListenerOptions>>]

Type parameters

NameType
K2extends string

Parameters

NameTypeDescription
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => key is K2

Returns

[Collection<K2, Listener<"", ListenerOptions>>, Collection<Exclude<string, K2>, Listener<"", ListenerOptions>>]

Inherited from

Store.partition

Defined in

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

partition<V2>(fn): [Collection<string, V2>, Collection<string, Exclude<Listener<"", ListenerOptions>, V2>>]

Type parameters

NameType
V2extends Listener<"", ListenerOptions, V2>

Parameters

NameType
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => value is V2

Returns

[Collection<string, V2>, Collection<string, Exclude<Listener<"", ListenerOptions>, V2>>]

Inherited from

Store.partition

Defined in

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

partition(fn): [Collection<string, Listener<"", ListenerOptions>>, Collection<string, Listener<"", ListenerOptions>>]

Parameters

NameType
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean

Returns

[Collection<string, Listener<"", ListenerOptions>>, Collection<string, Listener<"", ListenerOptions>>]

Inherited from

Store.partition

Defined in

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

partition<This, K2>(fn, thisArg): [Collection<K2, Listener<"", ListenerOptions>>, Collection<Exclude<string, K2>, Listener<"", ListenerOptions>>]

Type parameters

NameType
ThisThis
K2extends string

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => key is K2
thisArgThis

Returns

[Collection<K2, Listener<"", ListenerOptions>>, Collection<Exclude<string, K2>, Listener<"", ListenerOptions>>]

Inherited from

Store.partition

Defined in

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

partition<This, V2>(fn, thisArg): [Collection<string, V2>, Collection<string, Exclude<Listener<"", ListenerOptions>, V2>>]

Type parameters

NameType
ThisThis
V2extends Listener<"", ListenerOptions, V2>

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => value is V2
thisArgThis

Returns

[Collection<string, V2>, Collection<string, Exclude<Listener<"", ListenerOptions>, V2>>]

Inherited from

Store.partition

Defined in

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

partition<This>(fn, thisArg): [Collection<string, Listener<"", ListenerOptions>>, Collection<string, Listener<"", ListenerOptions>>]

Type parameters

Name
This

Parameters

NameType
fn(this: This, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean
thisArgThis

Returns

[Collection<string, Listener<"", ListenerOptions>>, Collection<string, Listener<"", ListenerOptions>>]

Inherited from

Store.partition

Defined in

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


random

random(): undefined | Listener<"", ListenerOptions>

Returns

undefined | Listener<"", ListenerOptions>

Inherited from

Store.random

Defined in

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

random(amount): Listener<"", ListenerOptions>[]

Parameters

NameType
amountnumber

Returns

Listener<"", ListenerOptions>[]

Inherited from

Store.random

Defined in

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


randomKey

randomKey(): undefined | string

Returns

undefined | string

Inherited from

Store.randomKey

Defined in

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

randomKey(amount): string[]

Parameters

NameType
amountnumber

Returns

string[]

Inherited from

Store.randomKey

Defined in

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


reduce

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

Type parameters

Name
T

Parameters

NameTypeDescription
fn(accumulator: T, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => T
initialValue?T

Returns

T

Inherited from

Store.reduce

Defined in

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


registerPath

registerPath(path): ListenerStore

Parameters

NameTypeDescription
pathPath

Returns

ListenerStore

Inherited from

Store.registerPath

Defined in

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


resolve

resolve(name): Listener<"", ListenerOptions>

Parameters

NameTypeDescription
namestring | Listener<"", ListenerOptions>

Returns

Listener<"", ListenerOptions>

Inherited from

Store.resolve

Defined in

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


reverse

reverse(): ListenerStore

Returns

ListenerStore

Inherited from

Store.reverse

Defined in

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


set

set(key, value): ListenerStore

Parameters

NameType
keystring
valueListener<"", ListenerOptions>

Returns

ListenerStore

Inherited from

Store.set

Defined in

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


some

some(fn): boolean

Parameters

NameTypeDescription
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean

Returns

boolean

Inherited from

Store.some

Defined in

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

some<T>(fn, thisArg): boolean

Type parameters

Name
T

Parameters

NameType
fn(this: T, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean
thisArgT

Returns

boolean

Inherited from

Store.some

Defined in

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


sort

sort(compareFunction?): ListenerStore

Parameters

NameTypeDescription
compareFunction?Comparator<string, Listener<"", ListenerOptions>>

Returns

ListenerStore

Inherited from

Store.sort

Defined in

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


sorted

sorted(compareFunction?): Collection<string, Listener<"", ListenerOptions>>

Parameters

NameTypeDescription
compareFunction?Comparator<string, Listener<"", ListenerOptions>>

Returns

Collection<string, Listener<"", ListenerOptions>>

Inherited from

Store.sorted

Defined in

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


sweep

sweep(fn): number

Parameters

NameTypeDescription
fn(value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean

Returns

number

Inherited from

Store.sweep

Defined in

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

sweep<T>(fn, thisArg): number

Type parameters

Name
T

Parameters

NameType
fn(this: T, value: Listener<"", ListenerOptions>, key: string, collection: ListenerStore) => boolean
thisArgT

Returns

number

Inherited from

Store.sweep

Defined in

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


tap

tap(fn): ListenerStore

Parameters

NameTypeDescription
fn(collection: ListenerStore) => void

Returns

ListenerStore

Inherited from

Store.tap

Defined in

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

tap<T>(fn, thisArg): ListenerStore

Type parameters

Name
T

Parameters

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

Returns

ListenerStore

Inherited from

Store.tap

Defined in

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


toJSON

toJSON(): Listener<"", ListenerOptions>[]

Returns

Listener<"", ListenerOptions>[]

Inherited from

Store.toJSON

Defined in

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


unload

unload(name): Promise<Listener<"", ListenerOptions>>

Parameters

NameTypeDescription
namestring | Listener<"", ListenerOptions>

Returns

Promise<Listener<"", ListenerOptions>>

Inherited from

Store.unload

Defined in

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


unloadAll

unloadAll(): Promise<Listener<"", ListenerOptions>[]>

Returns

Promise<Listener<"", ListenerOptions>[]>

Inherited from

Store.unloadAll

Defined in

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


values

values(): IterableIterator<Listener<"", ListenerOptions>>

Returns

IterableIterator<Listener<"", ListenerOptions>>

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

NameTypeDescription
entriesIterable<[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/collection.d.ts:414