Class NodeManager

constructor

• new NodeManager(player): NodeManager

• Parameters

  • player: Player<QueueContext, []>

  Returns NodeManager

Readonly info

all

• get all(): LavalinkNode[]

• Get all nodes

  Returns LavalinkNode[]

size

• get size(): number

• Get number of nodes

  Returns number

metrics

• get metrics(): NodeMetrics

• Get node metrics

  Returns NodeMetrics

get

• get(name): undefined | LavalinkNode

• Get a node by name

  Parameters

  • name: string

  Returns undefined | LavalinkNode

has

• has(name): boolean

• Check if a node exists

  Parameters

  • name: string

  Returns boolean

create

• create(options): LavalinkNode

• Create a new node

  Parameters

  • options: NodeOptions

  Returns LavalinkNode

delete

• delete(name): Promise<boolean>

• Delete a node

  Parameters

  • name: string

  Returns Promise<boolean>

connect

• connect(): Promise<void>

• Connect all nodes

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

• Disconnect all nodes

  Returns Promise<void>

relevant

• relevant(): LavalinkNode[]

• Get relevant nodes sorted by load and availability Returns nodes that are ready and have lowest load

  Returns LavalinkNode[]

keys

• keys(): IterableIterator<string>

• Get all node names

  Returns IterableIterator<string>

values

• values(): IterableIterator<LavalinkNode>

• Get all nodes

  Returns IterableIterator<LavalinkNode>

entries

• entries(): IterableIterator<[string, LavalinkNode]>

• Get all entries

  Returns IterableIterator<[string, LavalinkNode]>

fetchInfo

• fetchInfo(name): Promise<LavalinkInfo>

• Fetch and cache node info

  Parameters

  • name: string

    Node name

  Returns Promise<LavalinkInfo>

supports

• supports(type, value, nodeName?): boolean

• Check if a feature is supported by a node

  Parameters

  • type: "filter" | "source" | "plugin"

    Feature type (filter, source, plugin)
  • value: string

    Feature value (name)
  • Optional nodeName: string

    Optional node name (checks all if not specified)

  Returns boolean