Discolink
    Preparing search index...

    Interface NodeOptions

    Options for creating a node

    interface NodeOptions {
        name: string;
        clientId: string;
        statsInterval?: number;
        highestLatency?: number;
        reconnectDelay?: number;
        reconnectLimit?: number;
        handshakeTimeout?: number;
        origin: string;
        password: string;
        version?: number;
        userAgent?: string;
        sessionId?: string;
        stackTrace?: boolean;
        retryLimit?: number;
        requestTimeout?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    name: string

    A unique name for this node

    clientId: string

    The User Id of your Discord Bot

    statsInterval?: number

    Interval at which this node dispatches it's stats. Default: 60_000

    highestLatency?: number

    An assumption of this node's highest possible latency. Default: 2_000

    reconnectDelay?: number

    Number of milliseconds to wait between each reconnect. Default: 10_000

    reconnectLimit?: number

    Number of reconnects to attempt on unusual disconnect. Default: 3

    handshakeTimeout?: number

    Number of milliseconds to allow for initial handshake. Default: 5_000

    origin: string

    URL of your lavalink server

    password: string

    Password of your lavalink server

    version?: number

    The semver major of your lavalink server. Default: 4

    userAgent?: string

    The value to set the User-Agent header to. Default: $client/$version ($repository)

    sessionId?: string

    Id of the lavalink session you want to interact with (if any)

    stackTrace?: boolean

    Whether to include stack trace from lavalink server on error. Default: false

    retryLimit?: number

    Number of retries to allow for timed out requests. Default: 0

    requestTimeout?: number

    Number of milliseconds to allow per request. Default: 10_000