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

standard-bail

v2.0.1

Published

Makes callbacks that log and/or call the outer callback if there's an error so that you don't have to.

Downloads

15

Readme

standard-bail

Build Status

Makes callbacks that log and/or call the outer callback if there's an error so that you don't have to. An abstraction of the most typical kind of error handling callback.

It creates a callback that checks for an error and if there is one, it (optionally) logs it and (optionally) passes it back to the done function. If there isn't, it calls the success handler function you've defined.

Basically, you get to skip writing

if (error) {
  log(error, error.stack);
  outerDone(error);
}
else {
  …
}

and get to just write whatever was in the else. (Obviously, don't use this if you have to handle an error in a special or different way.)

It's just a way to DRY up callbacks a bit.

Installation

npm install standard-bail

Usage

Instead of:

function doAThing(outerDone) {
  someAPI(aCallback);

  function aCallback(error, result, otherThing) {
    if (error) {
      log(error, error.stack);
      outerDone(error);
    }
    else {
      // Use result and otherThing in case in which someAPI call succeeded.
    }
  }

You can do:

var StandardBail = require('standard-bail');
var sb = StandardBail({
  log: myLogFunction // optional
});

function doAThing(outerDone) {
  someAPI(sb(successHandler, outerDone));

  function successHandler(result, otherThing, done) {
      // Use result and otherThing in case in which someAPI call succeeded.
  }
}

Here, successHandlers doesn't worry about errors. sb will have already handled it in a way a jillion other errors are handled: by logging it and/or passing it to done.

StandardBail takes an opts object that currently has one property: log. Use it to tell it which function, if any, it should be logging with. The function should be ready to be passed two parameters: a message string and an error stack. It returns an sb function you can use to create your callbacks.

sb has two parameters, success and outerDone.

All are optional can be undefined or null. You really should have either a outerDone or a log, though, in order to avoid silent failures.

success will be passed all of the non-error parameters passed to the callback as well as whatever outerDone you provided.

Tests

Run tests with make test.

License

The MIT License (MIT)

Copyright (c) 2016 Jim Kang

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.