Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

layerr

perry-mitchell733.1kMIT3.0.0TypeScript support: included

Error wrapping utility for NodeJS and the browser

error, verror, err, nerror, exception, wrapper, extend

readme

Layerr

Errors, with.. layers..

A NodeJS and Web Error wrapping utility, based heavily on VError, but without all the extras and dependencies on Node core utilities. Written in Typescript, compiled to JavaScript and suitable for bundling in the browser.

Uses no dependencies, minifies well and is a great way to wrap errors as they propagate through complex applications (such as Express services, for instance).

Layerr is an ESM library, and as such you need a compatible environment in which to install and use it.

Installation

Install by running: npm install layerr.

Usage

Use it as a regular error:

const { Layerr } = require("layerr");

throw new Layerr("Test error");

Or use it to wrap errors:

doSomething().catch((err) => {
    throw new Layerr(err, "Failed doing something");
});

Layerr's can have info attached:

const { Layerr } = require("layerr");

function somethingElse() {
    throw new Layerr(
        {
            info: {
                code: 123,
            },
        },
        "Problem"
    );
}

somethingElse().catch((err: Layerr) => {
    const { code } = Layerr.info(err);
    // code === 123
});

Global Name

By default Layerr names all created errors as Layerr. You can change this name by calling setGlobalName, and revert it by passing null to this function:

import { Layerr, setGlobalName } from "layerr";

setGlobalName("CustomError");

const err = new Layerr("My error");

err.name; // "CustomError"

throw err;
// Uncaught Layerr [CustomError]: My error

Support

Layerr (v3) supports NodeJS 16 onwards. It should also support all major+current browsers, once compiled/bundled.

changelog

Layerr Changelog

v3.0.0

2024-04-22

  • Removed Layerr#cause due to typescript issues
  • setGlobalName helper
  • Strict mode types

v2.1.0

2024-04-18

  • Error assertion via assertError

v2.0.1

2023-07-17

  • React-Native entry in package.json

v2.0.0

2023-02-13

  • ESM

v1.0.0

2022-12-12

  • Major release
    • Class-based Layerr instance, compiled to function-style during build

v0.1.2

2020-08-29

  • Bugfix:
    • Arguments not specified in constructor for Layerr

v0.1.0

2020-08-27

  • Initial release