summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/bail/readme.md
blob: a5ca45d0f091309ccaf6b8e69e03d640a043dfd8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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