npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

irc-js

v2.0.0-beta.5

Published

An IRC library for node.js

Downloads

98

Readme

IRC-js

The best IRC library for node.js

Installation

Via command-line:

npm install irc-js

Via package.json:

{ "dependencies":
  { "irc-js": "2" }
}

Tests

make test

2.0 Notes

We recently released the first beta of IRC-js 2.0. This release brings many changes, and documentation is not quite ready.

IRC-js 2.0 uses a couple of new ECMAScript features, so currently you must use the --harmony flag when running it.

So, for the adventurous, here's how to get started with 2.0:

/* IRC-js 2.0 provides a set of objects representing IRC entities, such as:
 *    Client    An IRC client, create one of these first.
 *    Message   A client sends and receives instances of this object.
 *    Channel   An IRC channel.
 *    Person    An IRC user.
 * Here follows a simple bot demonstrating basic usage.
 */

var irc = require("irc-js");

/* First, lets create an IRC Client.
 * The quickest way is to use the laziness function `irc.connect()`.
 * It takes an object configuring the bot, and returns a Client instance.
 */
irc.connect({ nick: "bot500" }, function(bot) {
  /* This optional callback means the client has connected.
   * It receives one argument: the Client instance.
   * Use the `join()` method to join a channel:
   */
  bot.join("#irc-js", function(err, chan) {
    /* You get this callback when the client has joined the channel.
     * The argument here is any eventual Error, and the Channel joined.
     */
    if (err) {
      console.log("Could not join channel :(", err);
      return;
    }
    /*
     * Channels also have some handy methods:
     */
    chan.say("Hello!");
  });

  /* You can also access channels like this:
   * `bot.channels.get("#irc-js").say("Hello!");`
   */

  /* Often you want your bot to do something when it receives a specific type
   * of message, or when a message contains something of interest.
   * The `match()` method lets you do both.
   * Look for INVITE messages and join channels:
   */
  bot.match("INVITE", function(msg) {
    /* Here the argument is a Message instance.
     * You can look at the `from` property to see who sent it.
     * The `reply()` method sends a message to the appropriate channel or person:
     */
    msg.reply("Thanks for the invite! On my way.");
    /* Sometimes you need to know about the parameters an IRC message uses.
     * The INVITE message has two: invitee and channel.
     */
    bot.join(msg.params[1]);
  });

  /* You can look for messages matching a regular expression.
   * Each match group is passed as an argument to the callback function.
   */
  bot.match(/\bsomecommand\s+([a-z]+)\s+([0-9]+)/, function(msg, letters, digits) {
    /* Here, the `letters` argument contains the text matched by the first group.
     * And `digits` is the second match. More match groups means more arguments.
     */
  });
});