Type Alias Command

Type Declaration

• { channel: string; key: string | null; type: "join" }

  • channel: string

    The channel to join.

  • key: string | null

    Its key, when it has one.

  • type: "join"

• { channel: string; reason: string | null; type: "part" }

  • channel: string

    The channel to leave.

  • reason: string | null

    Why, shown to the others in it.

  • type: "part"

• { target: string; text: string; type: "send_message" }

  • target: string

    Where to say it.

  • text: string

    What to say.

  • type: "send_message"

• { target: string; text: string; type: "send_notice" }

  • target: string

    Where to send it.

  • text: string

    What to send.

  • type: "send_notice"

• { target: string; text: string; type: "send_action" }

  • target: string

    Where to send it.

  • text: string

    What we are doing.

  • type: "send_action"

• { nick: string; type: "set_nick" }

  • nick: string

    The nick to take.

  • type: "set_nick"

• { channel: string; topic: string | null; type: "set_topic" }

  • channel: string

    The channel.

  • topic: string | null

    The new topic, or nothing to clear it.

  • type: "set_topic"

• { message: string | null; type: "set_away" }

  • message: string | null

    The away message, or nothing to come back.

  • type: "set_away"

• { state: TypingState; target: string; type: "set_typing" }

  • state: TypingState

    How far along we are.

  • target: string

    Who we are typing to.

  • type: "set_typing"

• { emoji: string; msgid: string; target: string; type: "add_reaction" }

  • emoji: string

    The emoji.

  • msgid: string

    The message reacted to.

  • target: string

    The channel or person the message is in.

  • type: "add_reaction"

• { emoji: string; msgid: string; target: string; type: "remove_reaction" }

  • emoji: string

    The emoji to remove.

  • msgid: string

    The message.

  • target: string

    The channel or person the message is in.

  • type: "remove_reaction"

• { msgid: string; reason: string | null; target: string; type: "redact_message" }

  • msgid: string

    The message to delete.

  • reason: string | null

    Why, when the server wants a reason.

  • target: string

    Where the message is.

  • type: "redact_message"

• { at_ms: number; target: string; type: "mark_read" }

  • at_ms: number

    The last message read, in milliseconds since the Unix epoch. The engine writes the server-time the wire wants.

  • target: string

    The channel or person.

  • type: "mark_read"

• {
      before_msgid: string | null;
      limit: number;
      target: string;
      type: "fetch_history";
  }

  • before_msgid: string | null

    Fetch messages older than the message with this id.

  • limit: number

    How many to ask for.

  • target: string

    The channel or person.

  • type: "fetch_history"

• { key: string; type: "set_metadata"; value: string | null }

  • key: string

    The key, such as display-name, color or avatar.

  • type: "set_metadata"

  • value: string | null

    The value, or nothing to clear the key.

• { keys: string[]; type: "subscribe_metadata" }

  • keys: string[]

    The keys to watch.

  • type: "subscribe_metadata"

• { nick: string; type: "whois" }

  • nick: string

    Who to ask about.

  • type: "whois"

• {
      channel: string;
      new_name: string;
      reason: string | null;
      type: "rename_channel";
  }

  • channel: string

    The channel as it is called now.

  • new_name: string

    What to call it.

  • reason: string | null

    Why, shown to the others in it.

  • type: "rename_channel"

• {
      channel: string | null;
      description: string | null;
      type: "create_invite_link";
  }

  • channel: string | null

    The channel it joins, or nothing to invite to the network.

  • description: string | null

    What it is for.

  • type: "create_invite_link"

• { type: "list_invite_links" }
• { share_id: string; type: "delete_invite_link" }

  • share_id: string

    Which one, from [Command::ListInviteLinks].

  • type: "delete_invite_link"

• { code: string; type: "redeem_invite_code" }

  • code: string

    The code, which is the share id of the link that carried it.

  • type: "redeem_invite_code"

• { service: string; type: "generate_token" }

  • service: string

    Which service the token is for, such as FILEHOST.

  • type: "generate_token"

• { nicks: string[]; type: "watch_nicks" }

  • nicks: string[]

    The nicks to watch.

  • type: "watch_nicks"

• { nicks: string[]; type: "unwatch_nicks" }

  • nicks: string[]

    The nicks to stop watching.

  • type: "unwatch_nicks"

• { channel: string; signal: VoiceSignal; type: "send_voice_signal" }

  • channel: string

    The channel to signal in.

  • signal: VoiceSignal

    The frame. The engine encodes it as the JSON that travels in the tag.

  • type: "send_voice_signal"

• { reason: string | null; type: "quit" }

  • reason: string | null

    Why.

  • type: "quit"

• { line: string; type: "send_raw_line" }

  • line: string

    The line, without its terminator.

  • type: "send_raw_line"