obby-client for TypeScript
    Preparing search index...

    Type Alias Channel

    A channel we are in.

    type Channel = {
        log: MessageLog;
        members: { [key in CaseFolded]?: Membership };
        mentions: number;
        metadata: { [key in string]?: string };
        modes: { [key in string]?: string | null };
        name: string;
        named_modes: { [key in string]?: string | null };
        read_marker: string | null;
        topic: string | null;
        topic_by: string | null;
        typing: CaseFolded[];
        unread: number;
    }
    Index
    log members mentions metadata modes name named_modes read_marker topic topic_by typing unread
    log: MessageLog

    What was said.

    members: { [key in CaseFolded]?: Membership }

    Who is in it.

    mentions: number

    Unread messages that mention us.

    metadata: { [key in string]?: string }

    Metadata the server holds, such as display-name, color, avatar and bot.

    These are plain draft/metadata-2 keys with no vendor prefix, despite everything else Obby adds being namespaced.

    modes: { [key in string]?: string | null }

    Channel modes currently set, with their arguments.

    name: string

    The name as the server spells it.

    named_modes: { [key in string]?: string | null }

    Modes by their name rather than their letter, from draft/named-modes.

    A letter means nothing without the server telling you what it does, and two servers spell the same feature differently. The names are stable, so this is what a user interface should show and what a setting should be keyed by.

    read_marker: string | null

    The read marker timestamp the server last confirmed.

    topic: string | null

    The topic, when one is set.

    topic_by: string | null

    Who set the topic and when.

    typing: CaseFolded[]

    Who is composing a message here right now.

    unread: number

    Messages since the last read marker.

    Settings
    Member Visibility

    On This Page
    Properties