Class PlayerManager

Manages a cache of key-value pairs.

Hierarchy (View Summary)

DataManager<string, Player>
- PlayerManager

Index

Constructors

Properties

cache delete find node

Methods

add create destroy

Constructors

constructor

new PlayerManager(node: Node): PlayerManager
Parameters
- node: Node
Returns PlayerManager
Overrides DataManager.constructor
- Defined in work/lavaluna.js/lavaluna.js/src/managers/PlayerManager.ts:6

Properties

`Readonly`cache

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

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: Player, key: string) => boolean) => Player = ...

Finds a value in the cache matching the given predicate.

Type Declaration

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

node

node: Node

Methods

add

add(key: string, value: Player): Player
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: Player
  The value to be associated with the key in the cache.
Returns Player
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: PlayerOptions): Player
Create a new player with the given options.
Parameters
- options: PlayerOptions
  The options for creating the player.
Returns Player
The newly created player.
- Defined in work/lavaluna.js/lavaluna.js/src/managers/PlayerManager.ts:16

destroy

destroy(guildId: string): Promise<boolean>
A method to destroy the player for a given guild ID.
Parameters
- guildId: string
  The ID of the guild.
Returns Promise<boolean>
Whether the player was successfully destroyed.
- Defined in work/lavaluna.js/lavaluna.js/src/managers/PlayerManager.ts:30