Events

Events

All IRC commands found in RFC 1459 should be emitted by the IRCC. The human readable versions of numeric commands are also emitted. If the IRCC is unable to parse a command from a line received from the server, an 'unknownLine' event is emitted.

Below is a list of all the events that get emitted, excluding almost all of the numeric/human readable commands found in the RFC. Look at the Objects page for more information on the line object.

Events

Notable RFC defined events

• 001

  Emitted after a successful connection.

Non-RFC defined events

• unknownLine
  params:

  • line
    String. Raw line received from the server.

  Emitted when the IRCC isn't able to understand a line received from the server.

• lineReceived
  params:

  • line
    Line Object

  Emitted when the IRCC server receives a line and is able to parse the line into a Line Object.

• joined

  Emitted after the client has connected to the server, sent a JOIN command to the server, and when the client subsequently receives a RPL_NAMREPLY or RPL_TOPIC comment.

• disconnecting
  params:

  • reason
    Optional. The reason for the disconnection.
  • exception
    Optional. Conditional. If reason is 'error', then exception contains the exception thrown to cause the disconnection.

  Emitted when a timeout, error, or manual disconnect occurs within the client.

• disconnected

  Emitted when the client has completely disconnected from the server.

• pinged

  Emitted after the client has been pinged, and the client has responded with an appropriate pong message.

• reconnecting

  Emitted after the client disconnects, for any reason, and the 'tryReconnect' is set to [true].

• nicknameInUse

  Emitted when the server says the nickname that a user is trying to set is already in use. It is the users responsibility to call the 'setNick()' method when this event happens.

• leavingChannels

  List of channels that the client is parting from.

• topic
  params:

  • topic
    Empty string if no topic is set, otherwise it will be the topic the server reported.

  Emitted when the client receives info about the topic.

• names
  params:

  • names
    A list of strings. May be empty or undefined.

  Emitted when the client receives a list of names from the server.

• msg
  params:

  • from
    nick or channel message is from
  • to
    the bots nick or the channel the message was sent to
  • message
    the message that was sent

  Emitted when the client receives a 'PRIVMSG' line

• not
  params:

  • from
    nick or channel message is from
  • to
    the bots nick or the channel the message was sent to
  • message
    the message that was sent

  Emitted when the client receives a 'NOTICE' line

• userJoined
  params:

  • nick
    Nick of the user that joined
  • channel
    Channel the user joined

  Emitted when the client notices a user joined

• userLeft
  params:

  • nick
    Nick of the user that left
  • channel
    Channel the user parted from

  Emitted when the client notices a user left

• userQuit
  params:

  • nick
    Nick of the user that quit
  • message
    Message provided when the user sent the QUIT message

  Emitted when the client notices a user quit

• userKicked
  params:

  • kicker
    Nick of the user that sent the KICK command
  • channel
    Channel the user was kicked from
  • kickee
    Nick of the user that got kicked

  Emitted when the client notices a user was kicked from a channel

• userRenamed
  params:

  • oldnick
    The users old nick
  • newnick
    The users new nick

  Emitted when the client notices a user left