Interface RibbonSnapshot

interface RibbonSnapshot {
    api: APIDefaults;
    codec: Codec;
    emitter: {
        maxListeners: number;
        verbose: boolean;
    };
    flags: number;
    handling: Handling;
    lastDisconnectReason:
        | "ribbon closed normally"
        | "client closed ribbon"
        | "protocol error"
        | "protocol violation"
        | "no error provided"
        | "ribbon lost"
        | "payload data corrupted"
        | "too much data"
        | "negotiation error"
        | "server error"
        | "server restarting"
        | "temporary error"
        | "bad gateway"
        | "TLS error"
        | "ping timeout"
        | "failed to connect"
        | "server closed ribbon";
    lastReconnect: number;
    options: {
        logging: LoggingLevel;
        spooling: boolean;
    };
    pinger: {
        heartbeat: number;
        interval: Timeout;
        last: number;
        time: number;
    };
    receivedID: number;
    receivedQueue: {
        command: string;
        data?: any;
        id?: any;
    }[];
    reconnectCount: number;
    reconnectPenalty: number;
    self: Me;
    sentID: number;
    sentQueue: {
        id: number;
        packet: string | Buffer;
    }[];
    session: {
        ribbonID: null | string;
        tokenID: null | string;
    };
    spool: Spool;
    token: string;
    userAgent: string;
}

Properties

api codec emitter flags handling lastDisconnectReason lastReconnect options pinger receivedID receivedQueue reconnectCount reconnectPenalty self sentID sentQueue session spool token userAgent

Properties

api

api: APIDefaults

codec

codec: Codec

emitter

emitter: {
    maxListeners: number;
    verbose: boolean;
}

flags

flags: number

handling

handling: Handling

lastDisconnectReason

lastDisconnectReason:
    | "ribbon closed normally"
    | "client closed ribbon"
    | "protocol error"
    | "protocol violation"
    | "no error provided"
    | "ribbon lost"
    | "payload data corrupted"
    | "too much data"
    | "negotiation error"
    | "server error"
    | "server restarting"
    | "temporary error"
    | "bad gateway"
    | "TLS error"
    | "ping timeout"
    | "failed to connect"
    | "server closed ribbon"

lastReconnect

lastReconnect: number

options

options: {
    logging: LoggingLevel;
    spooling: boolean;
}

pinger

pinger: {
    heartbeat: number;
    interval: Timeout;
    last: number;
    time: number;
}

receivedID

receivedID: number

receivedQueue

receivedQueue: {
    command: string;
    data?: any;
    id?: any;
}[]

reconnectCount

reconnectCount: number

reconnectPenalty

reconnectPenalty: number

self

self: Me

sentID

sentID: number

sentQueue

sentQueue: {
    id: number;
    packet: string | Buffer;
}[]

session

session: {
    ribbonID: null | string;
    tokenID: null | string;
}

spool

spool: Spool

token

token: string

userAgent

userAgent: string

Settings

Member Visibility

On This Page

Properties