obby-client for TypeScript
    Preparing search index...

    Type Alias Config

    What a host needs to give the engine before it can connect.

    Every field but the nick has a default, so a host deserialising one only has to supply what it actually cares about. An empty username or realname is filled in from the nick.

    type Config = {
        alt_nicks?: string[];
        nick: string;
        password?: string;
        realname?: string;
        retention?: number;
        sasl?: SaslCredentials;
        username?: string;
    }
    Index
    alt_nicks? nick password? realname? retention? sasl? username?
    alt_nicks?: string[]

    Nicks to fall back through when the server says ours is taken during registration.

    Registration stalls forever if nobody answers a 433, so the engine walks this list and then starts appending underscores rather than leaving the connection hung.

    nick: string

    The nick to register with.

    password?: string

    The server password, sent as PASS before anything else.

    realname?: string

    The realname sent in USER. Defaults to the nick.

    retention?: number

    How many messages each channel and conversation keeps.

    sasl?: SaslCredentials

    What to authenticate with, when the server offers sasl.

    username?: string

    The username sent in USER. Defaults to the nick.

    Settings
    Member Visibility

    On This Page
    Properties