Skip to content

Allows you to customize the toString method of passed `err`. Also adds useful properties like `line`, `filename` and `column` to the `err` object.

License

Notifications You must be signed in to change notification settings

tunnckoCore/error-format

Repository files navigation

Allows you to customize the toString method of passed err. Also adds useful properties like line, filename and column to the err object.

code climate standard code style travis build status coverage status dependency status

Install

npm i error-format --save

Usage

For more use-cases see the tests

const errorFormat = require('error-format')

Adds bypassed .toString which you can customize through the fmt function.

Params

  • <err> {Error}: error object/instance
  • [fmt] {Function}: custom format function
  • returns {Error}: what comes from input (instance of error)

Example

var errorFormat = require('error-format')
var err = new TypeError('baz qux')

console.log(err.toString())
// => TypeError: baz qux

err = errorFormat(err, function fmt (headline) {
  if (this.message.indexOf('baz') !== -1) {
    headline += ' --- Line: ' + this.line
  }
  if (this.message.indexOf('qux') !== -1) {
    headline += ' --- Column: ' + this.column
  }
  return headline
})

console.log(err.toString())
// => TypeError: baz qux --- Line: 4 --- Column: 11

Related

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.

tunnckoCore.tk keybase tunnckoCore tunnckoCore npm tunnckoCore twitter tunnckoCore github

About

Allows you to customize the toString method of passed `err`. Also adds useful properties like `line`, `filename` and `column` to the `err` object.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published