Type alias IRCConnectionEvents

Type declaration

• authenticated: ((authed: boolean) => void)

  • • (authed: boolean): void

    • Emitted when the login to the server was successful.

      Note: "login" in this case doesn't account for NickServ or SASL success.

      Parameters

      • authed: boolean

      Returns void

• channel-list-item: ((data: { channel: string; topic: string; users: string }) => void)

  • • (data: { channel: string; topic: string; users: string }): void

    • Parameters

      • data: { channel: string; topic: string; users: string }

        • channel: string

        • topic: string

        • users: string

      Returns void

• channel-mode: ((data: { mode: string; modeTarget: string; type: string } & IIRCLine) => void)

  • • (data: { mode: string; modeTarget: string; type: string } & IIRCLine): void

    • A mode was set on a user in a channel you're in.

      Parameters

      • data: { mode: string; modeTarget: string; type: string } & IIRCLine

      Returns void

• disconnect: ((data: { message: string; raw: any; type: string }) => void)

  • • (data: { message: string; raw: any; type: string }): void

    • Disconnected from the server.

      Parameters

      • data: { message: string; raw: any; type: string }

        • message: string

        • raw: any

        • type: string

      Returns void

• error: ((data: { error: Error; fatal: boolean }) => void)

  • • (data: { error: Error; fatal: boolean }): void

    • Error event from the server.

      Parameters

      • data: { error: Error; fatal: boolean }

        • error: Error

        • fatal: boolean

      Returns void

• join: ((data: { channel: string; nickname: string }) => void)

  • • (data: { channel: string; nickname: string }): void

    • User joined a channel you are in.

      Parameters

      • data: { channel: string; nickname: string }

        • channel: string

        • nickname: string

      Returns void

• leave: ((data: { channel?: string; nickname: string; reason?: string; type: string }) => void)

  • • (data: { channel?: string; nickname: string; reason?: string; type: string }): void

    • User leaving event. Type can be quit, kick or part.

      Parameters

      • data: { channel?: string; nickname: string; reason?: string; type: string }

        • Optional channel?: string

        • nickname: string

        • Optional reason?: string

        • type: string

      Returns void

• line: ((line: IIRCLine, processed: boolean) => void)

  • • (line: IIRCLine, processed: boolean): void

    • Parsed line from the IRC server.

      Parameters

      • line: IIRCLine

      • processed: boolean

      Returns void

• message: ((data: { message: string; nickname: string; raw: IIRCLine; to: string; type: string }) => void)

  • • (data: { message: string; nickname: string; raw: IIRCLine; to: string; type: string }): void

    • Message event from the server.

      Parameters

      • data: { message: string; nickname: string; raw: IIRCLine; to: string; type: string }

        • message: string

        • nickname: string

        • raw: IIRCLine

        • to: string

        • type: string

      Returns void

• names: ((data: { channel: string; list: string[] }) => void)

  • • (data: { channel: string; list: string[] }): void

    • Nicks in a channel.

      Parameters

      • data: { channel: string; list: string[] }

        • channel: string

        • list: string[]

      Returns void

• nick: ((data: { newNick: string; oldNick: string }) => void)

  • • (data: { newNick: string; oldNick: string }): void

    • User changed their nickname.

      Parameters

      • data: { newNick: string; oldNick: string }

        • newNick: string

        • oldNick: string

      Returns void

• server-supports: ((supports: Record<string, unknown>) => void)

  • • (supports: Record<string, unknown>): void

    • Everything this server supports. See IRC documentation for command 005 or RPL_ISUPPORT for more info.

      Parameters

      • supports: Record<string, unknown>

      Returns void

• supported-modes: ((modes: Record<string, string>) => void)

  • • (modes: Record<string, string>): void

    • Supported channel user modes from the server (e.g. ohv: @%+)

      Parameters

      • modes: Record<string, string>

      Returns void

• user-mode: ((data: { mode: string; modeTarget: string; type: string } & IIRCLine) => void)

  • • (data: { mode: string; modeTarget: string; type: string } & IIRCLine): void

    • A mode was set on a user, usually you.

      Parameters

      • data: { mode: string; modeTarget: string; type: string } & IIRCLine

      Returns void