Blame view

node_modules/loud-rejection/readme.md 1.68 KB
aaac7fed   liuqimichale   add
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
  # loud-rejection [![Build Status](https://travis-ci.org/sindresorhus/loud-rejection.svg?branch=master)](https://travis-ci.org/sindresorhus/loud-rejection) [![Coverage Status](https://coveralls.io/repos/github/sindresorhus/loud-rejection/badge.svg?branch=master)](https://coveralls.io/github/sindresorhus/loud-rejection?branch=master)
  
  > Make unhandled promise rejections fail loudly instead of the default [silent fail](https://gist.github.com/benjamingr/0237932cee84712951a2)
  
  By default, promises fail silently if you don't attach a `.catch()` handler to them.
  
  Use this in top-level things like tests, CLI tools, apps, etc, **but not in reusable modules.**<br>
  Not needed in the browser as unhandled promises are shown in the console.
  
  
  ## Install
  
  ```
  $ npm install --save loud-rejection
  ```
  
  
  ## Usage
  
  ```js
  const loudRejection = require('loud-rejection');
  const promiseFn = require('promise-fn');
  
  // Install the unhandledRejection listeners
  loudRejection();
  
  promiseFn();
  ```
  
  Without this module it's more verbose and you might even miss some that will fail silently:
  
  ```js
  const promiseFn = require('promise-fn');
  
  function error(err) {
  	console.error(err.stack);
  	process.exit(1);
  }
  
  promiseFn().catch(error);
  ```
  
  ### Register script
  
  Alternatively to the above, you may simply require `loud-rejection/register` and the unhandledRejection listener will be automagically installed for you.
  
  This is handy for ES2015 imports:
  
  ```js
  import 'loud-rejection/register';
  ```
  
  
  ## API
  
  ### loudRejection([log])
  
  #### log
  
  Type: `Function`<br>
  Default: `console.error`
  
  Custom logging function to print the rejected promise. Receives the error stack.
  
  
  ## License
  
  MIT © [Sindre Sorhus](https://sindresorhus.com)