Class RainlinkNodeManager

The node manager class for managing all audio sending server/node

Hierarchy (view full)

Constructors

constructor

Properties

manager

Accessors

size values full

Methods

add getLeastUsed all remove get delete clear set forEach

Constructors

constructor

Properties

manager

manager: Rainlink

The rainlink manager

Accessors

size

  • get size(): number

  • Get how many elements of current database

    Returns number

    number

values

  • get values(): G[]

  • Get all current values of current database

    Returns G[]

    unknown[]

full

  • get full(): [string, G][]

  • Get all current values of current database

    Returns [string, G][]

    unknown[]

Methods

add

getLeastUsed

  • getLeastUsed(customNodeArray?): Promise<RainlinkNode>

  • Get a least used node.

    Parameters

    Returns Promise<RainlinkNode>

    RainlinkNode

all

  • all(): RainlinkNode[]

  • Get all current nodes

    Returns RainlinkNode[]

    RainlinkNode[]

remove

  • remove(name): void

  • Remove a node.

    Parameters

    • name: string

    Returns void

    void

get

  • get<D>(key): undefined | D

  • Get data from database

    Type Parameters

    Parameters

    • key: string

      key of that data

    Returns undefined | D

    D

delete

  • delete<D>(key): undefined | D

  • detete data from database and returns the deleted data

    Type Parameters

    Parameters

    • key: string

      key of that data

    Returns undefined | D

    D

clear

  • clear(): void

  • detete all data from database

    Returns void

set

  • set<D>(key, data): undefined | D

  • Set data from database

    Type Parameters

    Parameters

    • key: string

      the key you want to set

    • data: D

      data of that key

    Returns undefined | D

    D

forEach

  • forEach(callback): void

  • executes a provided function once for each array element.

    Parameters

    • callback: ((value: RainlinkNode, key: string) => unknown)

      Callback function

        • (value, key): unknown

        • Parameters

          Returns unknown

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods