edgeport - v1.0.6
    Preparing search index...

    Interface IrcConnectOptions

    Options for connect.

    1.0.4

    interface IrcConnectOptions {
        autoRejoin?: boolean;
        caps?: string[];
        hostname: string;
        nick: string;
        password?: string;
        port?: number;
        realname?: string;
        sasl?: IrcSasl;
        timeoutMs?: number;
        tls?: "off" | "implicit";
        username?: string;
    }
    Index
    autoRejoin? caps? hostname nick password? port? realname? sasl? timeoutMs? tls? username?
    autoRejoin?: boolean

    Automatically rejoin a channel when the server KICKs us from it.

    caps?: string[]

    Extra IRCv3 capabilities to request (only those the server offers are CAP REQ-ed).

    hostname: string

    IRC server host to dial (also the TLS certificate identity).

    nick: string

    The nickname to register.

    password?: string

    Server password sent via PASS before registration, when provided.

    port?: number

    TCP port; defaults to 6667 (plaintext) or 6697 (tls: 'implicit').

    realname?: string

    The USER realname (gecos); defaults to nick.

    sasl?: IrcSasl

    SASL credentials; triggers the IRCv3 CAP + SASL exchange before registration.

    timeoutMs?: number

    Per-read deadline in milliseconds for the registration handshake.

    tls?: "off" | "implicit"

    Transport security: 'off' (default) plaintext, or 'implicit' TLS (IRCS).

    username?: string

    The USER ident; defaults to nick.

    Settings
    Member Visibility

    On This Page
    Properties