diff options
Diffstat (limited to 'deps/node/deps/npm/node_modules/create-error-class/readme.md')
-rw-r--r-- | deps/node/deps/npm/node_modules/create-error-class/readme.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/deps/node/deps/npm/node_modules/create-error-class/readme.md b/deps/node/deps/npm/node_modules/create-error-class/readme.md new file mode 100644 index 00000000..1076de88 --- /dev/null +++ b/deps/node/deps/npm/node_modules/create-error-class/readme.md @@ -0,0 +1,54 @@ +# create-error-class [![Build Status](https://travis-ci.org/floatdrop/create-error-class.svg?branch=master)](https://travis-ci.org/floatdrop/create-error-class) + +> Create error class + + +## Install + +``` +$ npm install --save create-error-class +``` + + +## Usage + +```js +var createErrorClass = require('create-error-class'); + +var HTTPError = createErrorClass('HTTPError', function (props) { + this.message = 'Status code is ' + props.statusCode; +}); + +throw new HTTPError({statusCode: 404}); +``` + + +## API + +### createErrorClass(className, [setup]) + +Return constructor of Errors with `className`. + +#### className + +*Required* +Type: `string` + +Class name of Error Object. Should contain characters from `[0-9a-zA-Z_$]` range. + +#### setup +Type: `function` + +Setup function, that will be called after each Error object is created from constructor with context of Error object. + +By default `setup` function sets `this.message` as first argument: + +```js +var MyError = createErrorClass('MyError'); + +new MyError('Something gone wrong!').message; // => 'Something gone wrong!' +``` + +## License + +MIT © [Vsevolod Strukchinsky](http://github.com/floatdrop) |