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

boss-local

v2.0.11

Published

Starts or connects to the boss daemon on the local computer

Downloads

20

Readme

boss-local

Discuss Build Status Dependency Status Coverage Status

A interface to an instance of boss running on the same host.

Usage

Local boss instance (e.g. on the same server). If the daemon cannot be reached it will be started.

N.b. the daemon will drop to the user account specified in the config file so please ensure you have sufficient privileges to do this.

var connect = require('boss-local').connect,
  config = {
    boss: {
      rundir: '/var/run/boss',
      logdir: '/var/log/boss',
      timeout: 10000
    },
    debug: {
      daemon: false,
      cluster: false
    }
  }

connect(config, function(error, boss) {
  // we are now connected to local boss instance

  boss.listProcesses(function(error, processes) {
    // do something

    // close connection
    boss.disconnect()
  })
})

N.b. If you fail to close the connection to the daemon, your program will probably not exit.

Is Boss running?

Sometimes you don't want to start the daemon, you'd just like to know if boss is running on the current host or not.

var running = require('boss-local').running
  config = {
      boss: {
        rundir: '/var/run/boss',
        logdir: '/var/log/boss',
        timeout: 10000
      },
      debug: {
        daemon: false,
        cluster: false
      }
    }

running(config, function(isRunning) {
  if(isRunning) {
    console.info('boss is running')
  } else {
    console.info('boss is not running')
  }
}

Logging

By default boss will log messages to the console. If you wish to pass these somewhere else (or ignore them entirely, pass an additional object in to the connect function with four properties - info, warn, error, debug.

var connect = require('boss-local').connect,
  config = {
    boss: {
    rundir: '/var/run/boss',
    logdir: '/var/log/boss',
    timeout: 10000
  },
  debug: {
    daemon: false,
    cluster: false
  },
  logger = {
    info: function() {},
    warn: function() {},
    error: function() {},
    debug: function() {}
  }

connect(config, logger, function(error, boss) {
  // we are now connected to the boss instance
  ...
})

If you are making lots of connections, for convenience you may wish to bind these arguments to the function:

var connect = require('boss-local').connect,
  connect = connect.bind(null, {
    boss: {
      rundir: '/var/run/boss',
      logdir: '/var/log/boss',
      timeout: 10000
    },
    debug: {
      daemon: false,
      cluster: false
    }
  }, {
     info: function() {},
     warn: function() {},
     error: function() {},
     debug: function() {}
    }
  )

connect(function(error, boss) {
  // we are now connected to the boss instance
  ...
})

Documentation

  1. Methods
  2. Events