teamspeak.js - v1.11.2
    Preparing search index...

    Interface ClientOptions

    interface ClientOptions {
        host: string;
        port?: number;
        protocol?: "tcp" | "ssh";
        ssh?: { password?: string; username?: string; [key: string]: unknown };
    }
    Index

    Properties

    host port? protocol? ssh?

    Properties

    host: string

    The host you want to connect to.

    port?: number

    The port you want to connect to.

    protocol?: "tcp" | "ssh"

    The protocol you want to use. Default is 'tcp' (TeamSpeak 3).

    ssh?: { password?: string; username?: string; [key: string]: unknown }

    SSH authentication options (only used when protocol === 'ssh')

    Settings

    Member Visibility

    On This Page

    Properties