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

@sealsystems/failure

v1.2.4

Published

Easy handling of error codes and metadata.

Downloads

6

Readme

@sealsystems/failure

CircleCI AppVeyor

Easy handling of error codes and metadata.

Installation

npm install @sealsystems/failure

Quick start

First you need to add a reference to @sealsystems/failure within your application.

const failure = require('@sealsystems/failure');

Then you can create an error object.

const err = failure(42, 'Universal error.', { username: 'hugo' });

This creates an new object of type Error with some additional properties:

{
  name: 'SealError',
  code: 42,
  message: 'Universal error',
  metadata: {
    username: 'hugo'
  }
  ...
}

API

Creating an error objects

Create a new object of type Error.

const error = failure(code, message, metadata);

Parameter:

code       number   optional    error code
message    string   mandatory   error message
metadata   object   optional    error metadata

Result: new error object

Join metadata

Join metadata and error object metadata into a new metadata object for extended logging.

Attention: This function does not alter the errors metadata, it just returns a new metadata object.

const joinedMeta = failure.joinMeta(error, metadata);

Parameter:

error      object   mandatory   previously created error object
metadata   object   mandatory   additional metadata to join

Result: new metadata object

Export plain object

Export a plain new object for return in REST-API.

const plainNewObject = failure.httpExport(error);

Parameter:

error      object   mandatory   previously created error object

Result: new plain javascript object of this structure:

{
  code: error.code,
  message: error.message,
  metadata: error.metadata
}

Export JSON string

Export plain error object as JSON string for return in REST-API without bodyparser.

const stringifiedObject = failure.jsonHttpExport(error);

Parameter:

error      object   mandatory   previously created error object

Result: JSON string of plain object created by httpExport

Test for failure

For testing if an error is a failure you can call isFailure function.

if (failure.isFailure(error)) { ... }

Parameter:

error      object   mandatory   the error object to test

Assert failure

The assert function throws if the error is NOT(!) a failure.

failure.assert(error);

Parameter:

error      object   mandatory   the error object to test