Class NodeManager

constructor

• new NodeManager(player: Player): NodeManager

  Parameters

  • player: Player

  Returns NodeManager

Readonlyinfo

Readonlymetrics

Readonlyplayer

size

• get size(): number

  Returns number

  the number of elements in the Map.

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

  Get the state of a node

  Parameters

  • name: string

    Name of the node

  Returns NodeState

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

  Check if a node is in a certain state

  Parameters

  • name: string

    Name of the node

  • equals: NodeState

    Expected state of the node

  Returns boolean

create

• create(options: CreateNodeOptions): Node

  Create a new node

  Parameters

  • options: CreateNodeOptions

    Options for creating the node

  Returns Node

delete

• delete(name: string): boolean

  Delete a node

  Parameters

  • name: string

    Name of the node

  Returns boolean

  Remarks

  Only a disconnected node with no queues can be deleted, an error is thrown otherwise

supports

• supports(feat: FeatureTypes, name: string): Node[]

  List nodes that support a certain feature

  Parameters

  • feat: FeatureTypes

    Type of feature

  • name: string

    Name of the feature

  Returns Node[]

• supports(feat: FeatureTypes, name: string, node: string): boolean

  Check if a node supports a certain feature

  Parameters

  • feat: FeatureTypes

    Type of feature

  • name: string

    Name of the feature

  • node: string

    Name of the node

  Returns boolean

relevant

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

  List nodes that are ready, sorted by metrics

  Parameters

  • weights: Partial<NodeMetrics> = ...

    Numeric weights for each metric

  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>

  Disconnect from a specific node (all if none specified)

  Parameters

  • Optionalname: string

    Name of the node

  Returns Promise<void>

fetchInfo

• fetchInfo(name: string): Promise<LavalinkInfo>

  Fetch info for a specific node (cache-first)

  Parameters

  • name: string

    Name of the node

  Returns Promise<LavalinkInfo>

[iterator]

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

  Returns MapIterator<[string, Node]>