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

smacker

v1.0.5

Published

Smack your service, so it behaves as you want

Downloads

145

Readme

smacker

Don't smack your developers when a process misbehaves. It's hard to know everything a Node.js process does.

Did you know?

  • Packages you use can emit warnings on process.emitWarning for deprecation notices and unexpected usage, without affecting functionality.
  • Both SIGINT and SIGTERM will by default try to kill your process, without notifying you. This can be confusing when running your Node.js process in foreign environments.
  • Node.js v10.12.0 introduced a new event called multipleResolves - which they recommend should terminate your process, even though it doesn't default to that behaviour.

smacker gracefully handles all these nitty gritties, and fits perfectly into a microservice environment.

Usage

const smacker = require('smacker');
const Service = require('lib/Service');
const service = new Service();
smacker.start(service);

Check out the demo in test/demo.js.

smacker.start(service, {[config][, log] })

  • service <Object> must have a start and stop function, both returning a Promise
  • config <Object> configuration object, contains config for smacker - see below
  • log <Object> logging object for smacker to use, defaults to console. Should have info, warn, and fatal.

smacker will call service.start on smacker.start, and expect the resulting promise to resolve. It installs handlers for SIGINT, SIGTERM and SIGUSR2 and calls service.stop when it receives one of these signals.

Unhandled exceptions and unhandled promise rejections are caught, logged, and your process will be terminated with exit code 1.

It also ensures warnings from process.emitWarning are logged through your logging object.

config

  • logJson <Boolean> determines whether smacker will try to serialize the object before giving it to your logging object. Can be set via the LOGJSON environment variable. Defaults to false.
  • terminateOnMultipleResolves <Boolean> smacker can terminate on the multipleResolves event. This is not always desireable. It defaults to true, since that is recommended behaviour.
  • gracefulShutdownTimeout <Number> smacker will terminate after configured milliseconds (triggered by signals or natually), with exit code 1, if configured. Defaults to undefined.
  • gracefulStartupTimeout <Number> smacker will terminate after configured milliseconds, with exit code 1, if configured and the start-function isn't resolved. Defaults to undefined.
  • signalHandlers[signal] custom signal handlers can be installed after the start-function has been resolved. This will overwrite the native behaviour of the signals. Valid signals are SIGHUP, SIGPIPE, SIGUSR2.

Planned features

  • detecting if service.stop actually leaves the event loop empty