# error-formatter

> format an error into string / json for log

Latest version **1.0.5** (published 2015-12-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install error-formatter
pnpm add error-formatter
yarn add error-formatter
bun add error-formatter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2015-12-07 |
| First published | 2014-08-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | dead_horse |
| Maintainers | dead_horse |
| Keywords | error, log, string, json |

## Links

- npm: https://www.npmjs.com/package/error-formatter
- Repository: https://github.com/node-modules/error-formatter
- Issues: https://github.com/node-modules/error-formatter/issues
- npm.io page: https://npm.io/package/error-formatter

## Dependencies (1)

- [utility](https://npm.io/package/utility.md) ^1.0.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.5 (latest) — 2015-12-07
- 1.0.4 — 2015-10-08
- 1.0.3 — 2014-08-22

## README

error-formatter
---------

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![David deps][david-image]][david-url]
[![node version][node-image]][node-url]
[![Gittip][gittip-image]][gittip-url]

[npm-image]: https://img.shields.io/npm/v/error-formatter.svg?style=flat-square
[npm-url]: https://npmjs.org/package/error-formatter
[travis-image]: https://img.shields.io/travis/node-modules/error-formatter.svg?style=flat-square
[travis-url]: https://travis-ci.org/node-modules/error-formatter
[coveralls-image]: https://img.shields.io/coveralls/node-modules/error-formatter.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/node-modules/error-formatter?branch=master
[david-image]: https://img.shields.io/david/node-modules/error-formatter.svg?style=flat-square
[david-url]: https://david-dm.org/node-modules/error-formatter
[node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square
[node-url]: http://nodejs.org/download/
[gittip-image]: https://img.shields.io/gittip/dead-horse.svg?style=flat-square
[gittip-url]: https://www.gittip.com/dead-horse/

Formate error to string or json, for log use.

## Install

```bash
npm install error-formatter
```

## Usage

```js
var formater = require('error-formatter');

var err = new Error('test error');
err.host = '127.0.0.1';
err.code = 'DUPLICATE';
err.url = '/error';
err.data = {foo: 'bar'};

var msg = formater(err);
var json = formater.json(err);
var both = formater.bot(err);   // yield {text: text, json: json}
```

yield

```
2014-07-07 15:11:26.421 nodejs.ErrorException: DUPLICATEError: test error (127.0.0.1)
    at Object.<anonymous> (/Users/deadhorse/git/error-formatter/test/index.test.js:15:11)
    at Module._compile (module.js:449:26)
    at Object.Module._extensions..js (module.js:467:10)
    at Module.load (module.js:349:32)
    at Function.Module._load (module.js:305:12)
    at Module.require (module.js:357:17)
    at require (module.js:373:17)
    at /Users/deadhorse/git/error-formatter/node_modules/mocha/lib/mocha.js:172:27
    at Array.forEach (native)
    at Mocha.loadFiles (/Users/deadhorse/git/error-formatter/node_modules/mocha/lib/mocha.js:169:14)
    at Mocha.run (/Users/deadhorse/git/error-formatter/node_modules/mocha/lib/mocha.js:356:31)
    at Object.<anonymous> (/Users/deadhorse/git/error-formatter/node_modules/mocha/bin/_mocha:366:16)
    at Module._compile (module.js:449:26)
    at Object.Module._extensions..js (module.js:467:10)
    at Module.load (module.js:349:32)
    at Function.Module._load (module.js:305:12)
    at Function.Module.runMain (module.js:490:10)
    at startup (node.js:124:16)
    at node.js:803:3
pid: 91000
Host: dead-horsedeMacBook-Pro.local
URL: /error
Data: {"foo":"bar"}
2014-07-07 15:11:26.421
```

## License

MIT

---
_Source: https://npm.io/package/error-formatter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._