Class NodeManager

constructor

• new NodeManager(player: Player): NodeManager

  Parameters

  • player: Player

  Returns NodeManager

Readonlyinfo

size

• get size(): number

  Returns number

  the number of elements in the Map.

cache

• get cache(): Map<string, NodeMetrics>

  A map holding this manager's intrinsic data

  Returns Map<string, NodeMetrics>

ready

• get ready(): boolean

  Whether at least one node is ready

  Returns boolean

get

• get(name: string): Node | 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

  • name: string

  Returns Node | undefined

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

has

• has(name: string): boolean

  Parameters

  • name: 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<Node>

  Returns an iterable of values in the map

  Returns MapIterator<Node>

entries

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

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

  Returns MapIterator<[string, Node]>

state

• state(name: string): NodeState

  Returns the state of a node

  Parameters

  • name: string

    Name of the node

  Returns NodeState

• state(name: string, equals: NodeState): boolean

  Returns a boolean based on state comparison

  Parameters

  • name: string

    Name of the node

  • equals: NodeState

    Expected state of the node

  Returns boolean

create

• create(options: CreateNodeOptions): Node

  Creates a node

  Parameters

  • options: CreateNodeOptions

    Options to create from

  Returns Node

delete

• delete(name: string): boolean

  Deletes a disconnected node

  Parameters

  • name: string

    Name of the node

  Returns boolean

relevant

• relevant(weights?: Partial<NodeMetrics>): Node[]

  Returns a sorted list of nodes based on weights

  Parameters

  • weights: Partial<NodeMetrics> = ...

    Factors to prioritize based on weights (0-1 each)

  Returns Node[]

connect

• connect(): Promise<void>

  Connect to all nodes

  Returns Promise<void>

• connect(name: string): Promise<boolean>

  Connect to a specific node

  Parameters

  • name: string

    Name of the node

  Returns Promise<boolean>

disconnect

• disconnect(name?: string): Promise<void>

  Disconnects all nodes or a specific node if a name is provided

  Parameters

  • Optionalname: string

    Name of the node

  Returns Promise<void>

fetchInfo

• fetchInfo(name: string, force?: boolean): Promise<LavalinkInfo>

  Retrieves lavalink info of a node

  Parameters

  • name: string

    Name of the node

  • Optionalforce: boolean

    Whether to skip cache and make a request

  Returns Promise<LavalinkInfo>

[iterator]

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

  Returns MapIterator<[string, Node]>