https://github.com/shinnn/array-to-error

Create an error from an array of error messages
https://github.com/shinnn/array-to-error

Last synced: 27 days ago
JSON representation

Create an error from an array of error messages

• Host: GitHub
• URL: https://github.com/shinnn/array-to-error
• Owner: shinnn
• License: mit
• Created: 2015-10-06T06:23:26.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-12-16T10:30:33.000Z (almost 8 years ago)
• Last Synced: 2024-10-11T10:31:24.354Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://tonicdev.com/npm/array-to-error
• Size: 10.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# array-to-error

[![NPM version](https://img.shields.io/npm/v/array-to-error.svg)](https://www.npmjs.com/package/array-to-error)

[![Build Status](https://travis-ci.org/shinnn/array-to-error.svg?branch=master)](https://travis-ci.org/shinnn/array-to-error)

[![Coverage Status](https://img.shields.io/coveralls/shinnn/array-to-error.svg)](https://coveralls.io/github/shinnn/array-to-error?branch=master)

[![Dependency Status](https://david-dm.org/shinnn/array-to-error.svg)](https://david-dm.org/shinnn/array-to-error)

[![devDependency Status](https://david-dm.org/shinnn/array-to-error/dev-status.svg)](https://david-dm.org/shinnn/array-to-error#info=devDependencies)

Create an error from an array of error messages

```javascript

const arrayToError = require('array-to-error');

const error = arrayToError(['tranling comma on line 1', 'unexpected "(" on line 2']);

error.message; //=> 'tranling comma on line 1\nunexpected "(" on line 2'

error.reasons; //=> ['tranling comma on line 1', 'unexpected "(" on line 2']

```

## Installation

#### [npm](https://www.npmjs.com/)

```

npm install array-to-error

```

#### [Bower](https://bower.io/)

```

bower install array-to-error

```

## API

```javascript

const arrayToError = require('array-to-error');

```

### arrayToError(*messages* [, *constructor*])

*messages*: `Array` of strings  

*constructor*: `Object` (One of the [error constructors](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error#Error_types). [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error) by default)  

Return: `Object` (error instance)

It returns an instance of error whose `message` is made from its first argument joined with `\n`, and has an additional `reasons` property, the same value as its first argument.

The second argument is used as an error constructor.

```javascript

const arrayToError = require('array-to-error');

const error = arrayToError(['foo', 'bar'], TypeError);

error.message; //=> 'foo\nbar'

error.reasons; //=> ['foo', 'bar']

error.constructor; //=> TypeError

```

## License

Copyright (c) 2015 - 2016 [Shinnosuke Watanabe](https://github.com/shinnn)

Licensed under [the MIT License](./LICENSE).