Skip to content

Latest commit

 

History

History
110 lines (82 loc) · 3.06 KB

clientapi.md

File metadata and controls

110 lines (82 loc) · 3.06 KB
Raw

irc-framework Client instance API

Inherits EventEmitter (https://nodejs.org/api/events.html)

Constructor

new Irc.Client({
    nick: 'ircbot',
    username: 'ircbot',
    gecos: 'ircbot',
    encoding: 'utf8',
    version: 'node.js irc-framework',
    enable_chghost: false,
    enable_echomessage: false,
    auto_reconnect: true,
    auto_reconnect_wait: 4000,
    auto_reconnect_max_retries: 3,
    ping_interval: 30,
    ping_timeout: 120
});

Properties

.connected

If connected to the IRC network and successfully registered

Methods

.requestCap('twitch.tv/membership')

Request an extra IRCv3 capability

.use(middleware_fn())

Add middleware to handle the events for the client instance

.connect([connect_options])

Start connecting to the IRC network. If connect_options is provided it will override any options given to the constructor.

.raw(raw_data_line)

Send a raw line to the IRC server

.rawString('JOIN', '#channel')
.rawString(['JOIN', '#channel'])

Generate a formatted line from either an array or arguments to be sent to the IRC server.

.quit([quit_message])

Quit from the IRC network with the given message

.ping([message])

Ping the IRC server to show you're still alive.

.changeNick(nick)

Attempt to change the clients nick on the network

.say(target, message)

Send a message to the target.

.notice(target, message)

Send a notice to the target.

.join(channel [, key])

Join a channel, optionally with a key/password.

.part(channel [, message])

Part/leave a channel with an optional parting message.

.ctcpRequest(target, type [, paramN])

Send a CTCP request to target with any number of parameters.

.ctcpResponse(target, type [, paramN])

Send a CTCP response to target with any number of parameters.

.action(target, message)

Send an action message (typically /me) to a target.

.whois(nick [, cb])

Receive information about a user on the network if they exist. Optionally calls cb(event) with the result if provided.

.who(target [, cb])

Receive a list of users on the network that matchs the target. The target may be a channel or wildcard nick. Optionally calls cb(event) with the result if provided. Multiple calls to this function are queued up and run one at a time in order.

.list([, paramN])

Request that the IRC server sends a lsit of available channels. Extra parameters will be sent.

.channel(channel_name)

Create a channel object with the following methods:

  • `say(message)
  • `notice(message)
  • `action(message)
  • `part([part_message])
  • `join([key])
.match(match_regex, cb[, message_type])

Call cb() when any incoming message matches match_regex.

.matchNotice(match_regex, cb)

Call cb() when an incoming notice message matches match_regex.

.matchMessage(match_regex, cb)

Call cb() when an incoming plain message matches match_regex.

.matchAction(match_regex, cb)

Call cb() when an incoming action message matches match_regex.