@ctrl/irc

@ctrl/irc

A typed IRC client library for node

Based on irc-upd. Includes irc color decoding based on irc-colors.js

Install

npm install @ctrl/irc

Use

import { IrcClient } from '@ctrl/irc';
const client = new IrcClient('irc.yourserver.com', 'myNick', {
  channels: [],
  port: 7000,
  secure: true,
});
client.connect();

If you are connecting to a server with a self-signed certificate, opt out explicitly:

const client = new IrcClient('irc.yourserver.com', 'myNick', {
  secure: true,
  rejectUnauthorized: false,
});

If a server sends non-UTF-8 text, pass an explicit encoding. Encoding names are passed to iconv-lite; leaving encoding unset uses UTF-8.

const client = new IrcClient('irc.yourserver.com', 'myNick', {
  encoding: 'latin1',
});

Join a channel

client.join('#yourchannel yourpass');

Leave a channel

client.part('#yourchannel');

Send a message

// To channel
client.say('#yourchannel', 'hello');
// To user
client.say('nonbeliever', 'sup');

With typescript 4.1 template strings feature events can be fully typed.

// (from, message) parameters are typed via template strings matching `message#${string}`
client.addListener('message#yourchannel', (from, message) => {
  console.log(from + ' => #yourchannel: ' + message);
});

Debugging - subscribe to the raw messages and see what events are being parsed and re-emitted

client.on('raw', message => {
  console.log(message);
});

Links

• Modern irc spec - https://modern.ircdocs.horse/
• IRC v3 Specifications https://ircv3.net/irc/