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

dunnbot

v4.1.3

Published

Fast, minimal, extensible, and modern IRC bot for Node.js.

Downloads

5

Readme

dunnbot

Fast, minimal, extensible, and modern IRC bot for Node.js.

Install

yarn add dunnbot sqlite3

Or if you don't have yarn

npm install --save dunnbot sqlite3

Usage

↳ Getting Started

After you have installed dunnbot create an index.js file and put the following inside of it.

import Dunnbot from 'dunnbot'

const config = {
  bot: {
    nick: 'YourBot',
    channels: ['##yourchannel']
  }
}

const bot = new Dunnbot('irc.freenode.net:6667', config)

bot.start()

Then all you have to do is run node index.js and Dunnbot will connect to freenode as YourBot and join ##yourchannel.

↳ Database

By default Dunnbot is setup to run the db as a sqlite database in memory, so you do not have to worry about setting that stuff up. But since it is in memory, if you kill or restart the bot, the data is lost. So make sure to check out the Knex documentation on how to configure the db object.

To change your database configuration just modify the db key on config with your Knex config object.

For example:

const config = {
  ...,
  db: {
    client: 'pg',
    connection: {
      ...
    }
  }
}]

↳ Web Server

Dunnbot also has a ExpressJS app built into him which by default listens on 0.0.0.0 and port 9000.

You can use this ExpressJS app to either expose a url for people to access for your plugins, or allow your plugins to accept a webhook to do things in IRC.

You can change web server's configuration using the server key, similar to the db key on your config object.


config = {
  ...,
  server: {
    port: 8000,
    address: 'localhost'
  }
}

More on how to use the web server in the Developing Plugins section.

Developing Plugins

↳ Getting Started

Developing plugins for Dunnbot are pretty easy and straight foward. All you need to do is create a package that exports a class that extends Plugin class from @dunnbot/support.

import { Plugin } from '@dunnbot/support'

export default class MyPlugin extends Plugin {
  static description = 'This is my plugin.'
  static author = 'Your Name <[email protected]>'
  static help = 'This is where you tell or give examples of how to use the plugin.'

  handler () {
    /* All your logic will go here */
  }
}

↳ Events

All of Dunnbot's IRC is handled through events.