Interface NodeOptions

interface NodeOptions {
    hostname: string;
    name?: string;
    password: string;
    port: number;
    reconnectRetryAmount?: number;
    reconnectRetryDelay?: number;
    rest?: NodeRESTOptions;
    secure?: boolean;
    version?: "v4";
}

Index

Properties

hostname name? password port reconnectRetryAmount? reconnectRetryDelay? rest? secure? version?

Properties

hostname

hostname: string

The hostname for the node.

`Optional`name

name?: string

The name of the node.

password

password: string

The password for the node.

port

port: number

The port for the node.

`Optional`reconnectRetryAmount

reconnectRetryAmount?: number

The retryAmount for the node.

`Optional`reconnectRetryDelay

reconnectRetryDelay?: number

The retryDelay for the node.

`Optional`rest

rest?: NodeRESTOptions

Options for the REST

`Optional`secure

secure?: boolean

Whether the host uses SSL.

`Optional`version

version?: "v4"

Version of the Lavalink.