Class QueueManager<Context>

constructor

• new QueueManager<Context extends Record<string, unknown> = QueueContext>(
      player: Player,
  ): QueueManager<Context>

  Type Parameters

  • Context extends Record<string, unknown> = QueueContext

  Parameters

  • player: Player

  Returns QueueManager<Context>

Readonlyplayer

size

• get size(): number

  Returns number

  the number of elements in the Map.

get

• get(guildId: string): Queue<Context> | undefined

  Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

  Parameters

  • guildId: string

  Returns Queue<Context> | undefined

  Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

has

• has(guildId: string): boolean

  Parameters

  • guildId: string

  Returns boolean

  boolean indicating whether an element with the specified key exists or not.

keys

• keys(): MapIterator<string>

  Returns an iterable of keys in the map

  Returns MapIterator<string>

values

• values(): MapIterator<Queue<Context>>

  Returns an iterable of values in the map

  Returns MapIterator<Queue<Context>>

entries

• entries(): MapIterator<[string, Queue<Context>]>

  Returns an iterable of key, value pairs for every entry in the map.

  Returns MapIterator<[string, Queue<Context>]>

create

• create(options: CreateQueueOptions<Context>): Promise<Queue<Context>>

  Create a queue

  Parameters

  • options: CreateQueueOptions<Context>

    Options for creating the queue

  Returns Promise<Queue<Context>>

destroy

• destroy(guildId: string, reason?: string): Promise<void>

  Destroy a queue

  Parameters

  • guildId: string

    Id of the guild

  • reason: string = "destroyed"

    Reason for destroying

  Returns Promise<void>

sync

• sync(node: string, target?: "local" | "remote"): Promise<void>

  Sync multiple lavalink player data

  Parameters

  • node: string

    Name of the node

  • target: "local" | "remote" = "local"

    Target to update (local for queues, remote for node)

  Returns Promise<void>

relocate

• relocate(node: string): Promise<void>

  Relocate all queues of a specific node

  Parameters

  • node: string

    Name of the node

  Returns Promise<void>

[OnStateUpdateSymbol]

• "[OnStateUpdateSymbol]"(payload: PlayerUpdatePayload): Promise<void>

  Parameters

  • payload: PlayerUpdatePayload

  Returns Promise<void>

[OnEventUpdateSymbol]

• "[OnEventUpdateSymbol]"(payload: EventPayload): Promise<void>

  Parameters

  • payload: EventPayload

  Returns Promise<void>

[LookupSymbol]

• "[LookupSymbol]"(guildId: string): APIPlayer | undefined

  Parameters

  • guildId: string

  Returns APIPlayer | undefined

[UpdateSymbol]

• "[UpdateSymbol]"(
      guildId: string,
      payload: Partial<APIPlayer>,
      partial?: boolean,
  ): void

  Parameters

  • guildId: string
  • payload: Partial<APIPlayer>
  • partial: boolean = true

  Returns void

[iterator]

• "[iterator]"(): MapIterator<[string, Queue<Context>]>

  Returns MapIterator<[string, Queue<Context>]>