Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 1.65 KB

README.md

File metadata and controls

63 lines (42 loc) · 1.65 KB
Raw

IRC-Protocol build status

Streaming parser and serialiser for IRC protocol data.

Overview

This module allows you to consume and produce IRC protocol messages. It doesn't contain any logic, leaving that up to the developer. Also everything is streams.

Installation

Available via npm:

$ npm install irc-protocol

Or via git:

$ git clone git://github.com/deoxxa/irc-protocol.git node_modules/irc-protocol

Usage

Also see proxy.js.

#!/usr/bin/env node

var net = require("net"),
    IRCProtocol = require("./index");

var server = net.createServer(function(local) {
  var local_parser = new IRCProtocol.Parser(),
      remote_parser = new IRCProtocol.Parser(),
      local_serialiser = new IRCProtocol.Serialiser(),
      remote_serialiser = new IRCProtocol.Serialiser();

  var remote = net.createConnection(6667, "127.0.0.1");

  local.pipe(local_parser).pipe(local_serialiser).pipe(remote);
  remote.pipe(remote_parser).pipe(remote_serialiser).pipe(local);

  local_serialiser.on("data", function(data) { process.stdout.write(">> " + data); });
  remote_serialiser.on("data", function(data) { process.stdout.write("<< " + data); });
});

server.listen(6668);

License

3-clause BSD. A copy is included with the source.

Contact