Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • CompleteNodeOptions

Index

Properties

clientName

clientName: string

The client name to use.

default

'rose-lavalink'

connectionTimeout

connectionTimeout: number

The amount of time to allow to connect to the lavalink server before timing out. This must be less than the connect / reconnect retry delay.

default

15000

defaultRequestOptions

defaultRequestOptions: RequestOptions

The default request options to use.

host

host: string

The host for the node to use.

default

'localhost'

maxRetrys

maxRetrys: number

The maximum number of times to try to connect or reconnect. Setting this to 0 removes the limit.

default

10

password

password: string

The password for the node to use.

default

'youshallnotpass'

port

port: number

The port for the node to use.

default

2333

requestTimeout

requestTimeout: number

The time to wait before timing out a request.

default

15000

Optional resumeKey

resumeKey: string

A resume key to use when starting the node.

see

Lavalink Docs

Optional resumeKeyConfig

resumeKeyConfig: { key: string; timeout: number }

Data to configure resuming with. If undefined resuming will not be configured.

default

undefined

see

Lavalink Docs

Type declaration

  • key: string

    The resume key.

  • timeout: number

    The time in milliseconds after the wrapper disconnects that the lavalink server's session should be closed anyways.

retryDelay

retryDelay: number

The time in milliseconds to wait between connection or reconnection attempts. This must be greater than the connection timeout.

default

30000

secure

secure: boolean

If the connection is secure.

default

false

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method

Generated using TypeDoc