Documentation
Classes
@discord-player
utils
Queue

Queue

new Queue(strategy, initializer)
ParameterTypeOptionalDescription
strategyQueueStrategy-
initializerArray<T>-

Properties

public store: Array<T>

public strategy: QueueStrategy

public size: number

Methods

public add(item): void

ParameterTypeOptionalDescription
itemT | Array<T>-

public at(idx): undefined | T

ParameterTypeOptionalDescription
idxnumber-

public clear(): void

public clone(): Queue<T>

public dispatch(): undefined | T

public every(itemFilter): boolean

ParameterTypeOptionalDescription
itemFilterQueueItemFilter<T, boolean>-

public filter(itemFilter): Array<T>

ParameterTypeOptionalDescription
itemFilterQueueItemFilter<T, boolean>-

public find(itemFilter): undefined | T

ParameterTypeOptionalDescription
itemFilterQueueItemFilter<T, boolean>-

public isFIFO(): boolean

public isLIFO(): boolean

public map(itemFilter): Array<R>

ParameterTypeOptionalDescription
itemFilterQueueItemFilter<T, R>-

public remove(itemFilter): void

ParameterTypeOptionalDescription
itemFilterQueueItemFilter<T, boolean>-

public removeOne(itemFilter): void

ParameterTypeOptionalDescription
itemFilterQueueItemFilter<T, boolean>-

public shuffle(): void

public some(itemFilter): boolean

ParameterTypeOptionalDescription
itemFilterQueueItemFilter<T, boolean>-

public toArray(): Array<T>

public toJSON(): Array<T>

public toString(): string

public static from(data, strategy): Queue<T>

ParameterTypeOptionalDescription
dataArray<T>-
strategyQueueStrategy-