Skip to content

QueueState

The committed schedule of one DisTubeQueue: an immutable value replaced on every commit.

Metadata is the client’s caller-metadata type, threaded so a read of item.metadata needs no cast.

Type Parameter Default type
Metadata unknown
Property Type Description
autoplay boolean -
current QueueItem<Metadata> | undefined -
history readonly QueueItem<Metadata>[] Recently ended occurrences, newest last, bounded by DisTubeOptions.historySize.
repeat RepeatMode -
status QueueStatus -
upcoming readonly QueueItem<Metadata>[] -