https://github.com/blakeembrey/make-error-cause

Make your own nested errors
https://github.com/blakeembrey/make-error-cause

caused-by error error-handling error-reporting make-error nested-errors stack-traces

Last synced: about 2 months ago
JSON representation

Make your own nested errors

• Host: GitHub
• URL: https://github.com/blakeembrey/make-error-cause
• Owner: blakeembrey
• License: other
• Created: 2015-12-12T01:11:24.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-12-12T07:05:05.000Z (9 months ago)
• Last Synced: 2024-07-12T11:10:38.492Z (2 months ago)
• Topics: caused-by, error, error-handling, error-reporting, make-error, nested-errors, stack-traces
• Language: TypeScript
• Homepage:
• Size: 671 KB
• Stars: 67
• Watchers: 3
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Make Error Cause

[![NPM version][npm-image]][npm-url]

[![NPM downloads][downloads-image]][downloads-url]

[![Build status][travis-image]][travis-url]

[![Test coverage][coveralls-image]][coveralls-url]

> Make your own nested errors.

## Features

- Compatible with node.js and browsers

- Works with `instanceof`

- Automatic full stack traces in node.js (supports [`inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options))

- Output full stack trace with `fullStack(err)`

- Extends [`make-error`](https://github.com/JsCommunity/make-error)

## Installation

```

npm install make-error-cause --save

```

## Usage

```js

import { BaseError, fullStack } from "make-error-cause";

class CustomError extends BaseError {

  constructor(message, cause) {

    super(message, cause);

  }

}

const error = new Error("Boom!");

const customError = new CustomError("Another boom!", error);

console.log(customError); // Automatically prints full stack trace using `fullStack(this)`.

console.log(customError.cause); // Check causes via the `.cause` property.

console.log(customError instanceof Error); //=> true

```

## Attribution

Inspired by [`verror`](https://www.npmjs.com/package/verror), and others, but created lighter and without core dependencies for browser usage.

Other references:

- [Java](https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html)

- [Python](https://www.python.org/dev/peps/pep-3134/)

## License

Apache 2.0

[npm-image]: https://img.shields.io/npm/v/make-error-cause.svg?style=flat

[npm-url]: https://npmjs.org/package/make-error-cause

[downloads-image]: https://img.shields.io/npm/dm/make-error-cause.svg?style=flat

[downloads-url]: https://npmjs.org/package/make-error-cause

[travis-image]: https://img.shields.io/travis/blakeembrey/make-error-cause.svg?style=flat

[travis-url]: https://travis-ci.org/blakeembrey/make-error-cause

[coveralls-image]: https://img.shields.io/coveralls/blakeembrey/make-error-cause.svg?style=flat

[coveralls-url]: https://coveralls.io/r/blakeembrey/make-error-cause?branch=master