1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: avoid mentioning 'uncaughtException'

Browse Source 
Avoid suggesting using `'uncaughtException'` for emitted errors.

PR-URL: https://github.com/nodejs/node/pull/16905
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
This commit is contained in:
Luigi Pinca 2017-11-09 17:58:42 +01:00 committed by Anna Henningsen
parent fe932a1204
commit 9531fcbb2e
No known key found for this signature in database
GPG Key ID: 9C63F3A6CD2AD8F9
1 changed files with 2 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/api/events.md
View File

@ -142,20 +142,8 @@ myEmitter.emit('error', new Error('whoops!'));
// Throws and crashes Node.js
```
To guard against crashing the Node.js process, a listener can be registered
on the [`process` object's `uncaughtException` event][] or the [`domain`][] module
can be used. (Note, however, that the `domain` module has been deprecated.)
```js
const myEmitter = new MyEmitter();
process.on('uncaughtException', (err) => {
console.error('whoops! there was an error');
});
myEmitter.emit('error', new Error('whoops!'));
// Prints: whoops! there was an error
```
To guard against crashing the Node.js process the [`domain`][] module can be
used. (Note, however, that the `domain` module has been deprecated.)
As a best practice, listeners should always be added for the `'error'` events.
@ -594,5 +582,4 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
[`fs.ReadStream`]: fs.html#fs_class_fs_readstream
[`net.Server`]: net.html#net_class_net_server
[`process.on('warning')`]: process.html#process_event_warning
[`process` object's `uncaughtException` event]: process.html#process_event_uncaughtexception
[stream]: stream.html