diff options
Diffstat (limited to 'tools/node_modules/eslint/node_modules/bail/readme.md')
| -rw-r--r-- | tools/node_modules/eslint/node_modules/bail/readme.md | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/tools/node_modules/eslint/node_modules/bail/readme.md b/tools/node_modules/eslint/node_modules/bail/readme.md new file mode 100644 index 0000000000..a5ca45d0f0 --- /dev/null +++ b/tools/node_modules/eslint/node_modules/bail/readme.md @@ -0,0 +1,71 @@ +# bail [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov] + +:warning: Throw a given error. + +## Installation + +[npm][npm-install]: + +```bash +npm install bail +``` + +## Usage + +```js +var bail = require('bail'); + +bail(); + +bail(new Error('failure')); +// Error: failure +// at repl:1:6 +// at REPLServer.defaultEval (repl.js:154:27) +// ... +``` + +## API + +### `bail([err])` + +Throw a given error. + +###### Parameters + +* `err` (`Error?`) — Optional error. + +###### Throws + +* `Error` — Given error, if any. + +## Related + +* [`noop`][noop] +* [`noop2`][noop2] +* [`noop3`][noop3] + +## License + +[MIT][license] © [Titus Wormer][author] + +<!-- Definitions --> + +[travis-badge]: https://img.shields.io/travis/wooorm/bail.svg + +[travis]: https://travis-ci.org/wooorm/bail + +[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/bail.svg + +[codecov]: https://codecov.io/github/wooorm/bail + +[npm-install]: https://docs.npmjs.com/cli/install + +[license]: LICENSE + +[author]: http://wooorm.com + +[noop]: https://www.npmjs.com/package/noop + +[noop2]: https://www.npmjs.com/package/noop2 + +[noop3]: https://www.npmjs.com/package/noop3 |