Skip to content

Commit

Permalink
doc: avoid mentioning 'uncaughtException'
Browse files Browse the repository at this point in the history
Avoid suggesting using `'uncaughtException'` for emitted errors.

PR-URL: #16905
Reviewed-By: Ben Noordhuis <[email protected]>
  • Loading branch information
lpinca authored and MylesBorins committed Dec 11, 2017
1 parent 78b82b0 commit 4b35dfb
Showing 1 changed file with 2 additions and 15 deletions.
17 changes: 2 additions & 15 deletions doc/api/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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

0 comments on commit 4b35dfb

Please sign in to comment.