array-to-error

Create an error from an array of error messages

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
array-to-error
1.1.17 years ago8 years agoMinified + gzip package size for array-to-error in KB

Readme

array-to-error
NPM version Build Status Coverage Status Dependency Status devDependency Status
Create an error from an array of error messages
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

npm install array-to-error

Bower

bower install array-to-error

API

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

arrayToError(messages , constructor)

messages: Array of strings
constructor: Object (One of the error constructors. 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.
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
Licensed under the MIT License.