Class NodeManager

Manages a cache of key-value pairs.

Hierarchy (View Summary)

DataManager<string, Node>
- NodeManager

Index

Constructors

Properties

cache delete find manager

Accessors

Methods

add create createPlayer destroy getPlayer search

Constructors

constructor

new NodeManager(manager: Lavaluna): NodeManager
Parameters
- manager: Lavaluna
Returns NodeManager
Overrides DataManager.constructor
- Defined in work/lavaluna.js/lavaluna.js/src/managers/NodeManager.ts:28

Properties

`Readonly`cache

cache: WishMap<string, Node> = ...

The underlying cache store.

delete

delete: (key: string) => boolean = ...

Deletes an entry from the cache by key.

Type Declaration

- (key: string): boolean
- Removes the specified element from the map.
  Parameters
  - key: string
  Returns boolean
  Fires
  WishMap#delete

find

find: (fn: (value: Node, key: string) => boolean) => Node = ...

Finds a value in the cache matching the given predicate.

Type Declaration

- (fn: (value: Node, key: string) => boolean): Node
- Returns the first value that passes the provided function.
  Parameters
  - fn: (value: Node, key: string) => boolean
    Function to test each entry
  Returns Node

manager

manager: Lavaluna

Accessors

leastLoad

get leastLoad(): Node[]
Get the nodes with the least load.

Returns Node[]
An array of nodes with the least load.
- Defined in work/lavaluna.js/lavaluna.js/src/managers/NodeManager.ts:15

Methods

add

add(key: string, value: Node): Node
Adds a key-value pair to the cache if the key does not exist, and returns the value.
Parameters
- key: string
  The key to be added to the cache.
- value: Node
  The value to be associated with the key in the cache.
Returns Node
The value associated with the key in the cache.
Inherited from DataManager.add
- Defined in work/lavaluna.js/lavaluna.js/src/managers/DataManager.ts:17

create

create(options: NodeOptions): Node
Creates a new Node based on the provided options.
Parameters
- options: NodeOptions
  The options for creating the Node.
Returns Node
The newly created Node.
- Defined in work/lavaluna.js/lavaluna.js/src/managers/NodeManager.ts:38

createPlayer

createPlayer(options: PlayerOptions): Player
Parameters
- options: PlayerOptions
Returns Player
- Defined in work/lavaluna.js/lavaluna.js/src/managers/NodeManager.ts:135

destroy

destroy(name: string): Promise<boolean>
Destroys a node with the given name.
Parameters
- name: string
  The name of the node to destroy.
Returns Promise<boolean>
A promise that resolves to true if the node is successfully destroyed, otherwise false.
- Defined in work/lavaluna.js/lavaluna.js/src/managers/NodeManager.ts:54

getPlayer

getPlayer(guildId: string): Player
Retrieves the player from cache for the given guild ID.
Parameters
- guildId: string
  The ID of the guild.
Returns Player
The player for the given guild ID, or null if not found.
- Defined in work/lavaluna.js/lavaluna.js/src/managers/NodeManager.ts:129

search

search(query: SearchQuery, options?: SearchOptions): Promise<SearchResult>
Search for a query and return the search result.
Parameters
- query: SearchQuery
  The search query object.
- Optionaloptions: SearchOptions
Returns Promise<SearchResult>
A promise that resolves to the search result.
- Defined in work/lavaluna.js/lavaluna.js/src/managers/NodeManager.ts:66