Class Queue

constructor

• new Queue(player: Player): Queue

  Constructor of the queue.

  Parameters

  • player: Player

    Player instance.

  Returns Queue

  Example

  const queue = Structures.Queue(player);
  
  console.log(queue.size); // 0
  queue.add(track);
  console.log(queue.size); // 1
  Copy

current

history

Readonlyplayer

tracks

Readonlyutils

size

• get size(): number

  Get the track size of the queue.

  Returns number

  The track size of the queue.

  Example

  const queue = player.queue;
  
  console.log(queue.size); // 0
  queue.add(track);
  
  console.log(queue.size); // 1
  queue.add([track1, track2]);
  
  console.log(queue.size); // 3
  queue.shift();
  console.log(queue.size); // 2
  
  queue.clear();
  console.log(queue.size); // 0
  Copy

totalSize

• get totalSize(): number

  Get the total track size of the queue (Includes the current track).

  Returns number

  The total track size of the queue.

  Example

  const queue = player.queue;
  
  console.log(queue.totalSize); // 0
  queue.add(track);
  
  console.log(queue.totalSize); // 1
  queue.add([track1, track2]);
  
  console.log(queue.totalSize); // 3
  queue.shift();
  console.log(queue.totalSize); // 2
  
  queue.clear();
  console.log(queue.totalSize); // 0
  Copy

add

• add(
      track: TrackResolvableStructure | TrackResolvableStructure[],
      position?: number,
  ): Promise<Queue>

  Add a track or tracks to the queue.

  Parameters

  • track: TrackResolvableStructure | TrackResolvableStructure[]

    The track or tracks to add.

  • Optionalposition: number

    The position to add the track or tracks.

  Returns Promise<Queue>

  The queue instance.

  Example

  const queue = player.queue;
  
  console.log(queue.size); // 0
  
  await queue.add(track);
  console.log(queue.size); // 1
  
  await queue.add([track1, track2]);
  console.log(queue.size); // 3
  
  await queue.add(track3, 1);
  console.log(queue.size); // 4
  console.log(queue.tracks); // [track1, track3, track2, track]
  Copy

clear

• clear(): Promise<Queue>

  Clear the queue.

  Returns Promise<Queue>

  The queue instance.

  Example

  const queue = player.queue;
  
  console.log(queue.size); // 0
  await queue.add(track);
  await queue.add(track1, track2);
  
  console.log(queue.size); // 3
  await queue.clear();
  console.log(queue.size); // 0
  Copy

isEmpty

• isEmpty(): boolean
  Readonly

  Check if the queue is empty.

  Returns boolean

  True if the queue is empty.

  Example

  const queue = player.queue;
  
  console.log(queue.isEmpty()); // true
  queue.add(track);
  
  console.log(queue.isEmpty()); // false
  queue.clear();
  
  console.log(queue.isEmpty()); // true
  Copy

move

• move(track: Track, to: number): Promise<Queue>

  Move a track to a specific position in the queue.

  Parameters

  • track: Track

    The track to move.

  • to: number

    The position to move.

  Returns Promise<Queue>

  The queue instance.

  Example

  const queue = player.queue;
  await queue.add(track);
  await queue.add(track1);
  await queue.add(track2);
  
  console.log(queue.tracks); // [track, track1, track2]
  await queue.move(track1, 0);
  console.log(queue.tracks); // [track1, track, track2]
  Copy

previous

• previous(remove?: boolean): Promise<Track | null>

  Get the previous track of the queue.

  Parameters

  • Optionalremove: boolean = false

    Whether to remove the track from the previous queue.

  Returns Promise<Track | null>

  The previous track of the queue.

  Example

  const queue = player.queue;
  
  console.log(await queue.previous()); // null
  queue.add(track);
  queue.add(track2);
  
  console.log(await queue.previous()); // track
  console.log(await queue.previous(true)); // track and remove it from the previous tracks
  Copy

shift

• shift(): Promise<TrackResolvableStructure | null>

  Get the first track of the queue.

  Returns Promise<TrackResolvableStructure | null>

  The first track of the queue.

  Example

  const queue = player.queue;
  
  console.log(await queue.shift()); // null
  await queue.add(track);
  
  console.log(await queue.shift()); // track
  await queue.add(track2);
  Copy

shuffle

• shuffle(): Promise<Queue>

  Shuffle the queue.

  Returns Promise<Queue>

  The queue instance.

  Example

  const queue = player.queue;
  
  console.log(queue.size); // 0
  await queue.add(track);
  await queue.add(track1, track2);
  
  console.log(queue.size); // 3
  console.log(queue.tracks); // [track, track1, track2]
  
  await queue.shuffle();
  console.log(queue.tracks); // [track2, track, track1]
  Copy

splice

• splice(
      start: number,
      deleteCount: number,
      tracks?: TrackResolvableStructure | TrackResolvableStructure[],
  ): Promise<Queue>

  Delete tracks from the queue.

  Parameters

  • start: number

    The start index.

  • deleteCount: number

    The number of tracks to delete.

  • Optionaltracks: TrackResolvableStructure | TrackResolvableStructure[]

    The tracks to add.

  Returns Promise<Queue>

  The queue instance.

  Example

  const queue = player.queue;
  await queue.add(track);
  await queue.add(track1);
  await queue.add(track2);
  
  console.log(queue.tracks); // [track, track1, track2]
  await queue.splice(1, 1);
  console.log(queue.tracks); // [track, track2]
  Copy

toJSON

• toJSON(): QueueJson

  Convert the queue to a JSON object.

  Returns QueueJson

  The queue JSON object.

  Example

  const queue = player.queue;
  await queue.add(track);
  
  console.log(queue.toJSON()); // { tracks: [track], history: [], current: null }
  Copy

unshift

• unshift(...tracks: Track[]): Promise<Queue>

  Add tracks to the beginning of the queue.

  Parameters

  • ...tracks: Track[]

    The tracks to add.

  Returns Promise<Queue>

  The queue instance.

  Example

  const queue = player.queue;
  
  console.log(queue.size); // 0
  await queue.unshift(track);
  
  console.log(queue.size); // 1
  await queue.unshift(track1, track2);
  
  console.log(queue.size); // 3
  console.log(queue.tracks); // [track1, track2, track]
  Copy