Shoukaku
    Preparing search index...

    Interface ShoukakuOptions

    interface ShoukakuOptions {
        moveOnDisconnect?: boolean;
        nodeResolver?: (
            nodes: Map<string, Node>,
            connection?: Connection,
        ) => Node | undefined;
        reconnectInterval?: number;
        reconnectTries?: number;
        restTimeout?: number;
        resume?: boolean;
        resumeByLibrary?: boolean;
        resumeTimeout?: number;
        structures?: Structures;
        userAgent?: string;
        voiceConnectionTimeout?: number;
    }
    Index

    Properties

    moveOnDisconnect? nodeResolver? reconnectInterval? reconnectTries? restTimeout? resume? resumeByLibrary? resumeTimeout? structures? userAgent? voiceConnectionTimeout?

    Properties

    moveOnDisconnect?: boolean

    Whether to move players to a different Lavalink node when a node disconnects

    nodeResolver?: (
        nodes: Map<string, Node>,
        connection?: Connection,
    ) => Node | undefined

    Node Resolver to use if you want to customize it

    reconnectInterval?: number

    Timeout before trying to reconnect

    reconnectTries?: number

    Number of times to try and reconnect to Lavalink before giving up

    restTimeout?: number

    Time to wait for a response from the Lavalink REST API before giving up

    resume?: boolean

    Whether to resume a connection on disconnect to Lavalink (Server Side) (Note: DOES NOT RESUME WHEN THE LAVALINK SERVER DIES)

    resumeByLibrary?: boolean

    Whether to resume the players by doing it in the library side (Client Side) (Note: TRIES TO RESUME REGARDLESS OF WHAT HAPPENED ON A LAVALINK SERVER)

    resumeTimeout?: number

    Time to wait before lavalink starts to destroy the players of the disconnected client

    structures?: Structures

    Custom structures for shoukaku to use

    userAgent?: string

    User Agent to use when making requests to Lavalink

    voiceConnectionTimeout?: number

    Timeout before abort connection

    Settings

    Member Visibility

    On This Page

    Properties