Skip to content

Commit

Permalink
docs: fix handleUncaughtExceptions docs typos (#1885)
Browse files Browse the repository at this point in the history
There are a few lines in docs for `handleUncaughtExceptions` option,
both in markdown docs and in jsdoc, which seem irrelevant and
disconnected. This appears to be a mistake that has been copied to
several places.
  • Loading branch information
josephharrington committed Nov 23, 2021
1 parent 71c7f49 commit 4d404d4
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 12 deletions.
8 changes: 2 additions & 6 deletions docs/_api/server.md
Expand Up @@ -53,9 +53,7 @@ routes and handlers for incoming requests.
`res.send()`.
- `options.handleUncaughtExceptions` **[Boolean][26]** When true restify
will use a domain to catch and respond to any uncaught
exceptions that occur in it's handler stack.
[bunyan][27] instance.
response header, default is `restify`. Pass empty string to unset the header.
exceptions that occur in its handler stack.
Comes with significant negative performance impact. (optional, default `false`)
- `options.spdy` **[Object][24]?** Any options accepted by
[node-spdy][29].
Expand Down Expand Up @@ -118,10 +116,8 @@ Creates a new Server.
`res.send()`.
- `options.handleUncaughtExceptions` **[Boolean][26]** When true restify
will use a domain to catch and respond to any uncaught
exceptions that occur in it's handler stack.
exceptions that occur in its handler stack.
Comes with significant negative performance impact.
[bunyan][27] instance.
response header, default is `restify`. Pass empty string to unset the header. (optional, default `false`)
- `options.spdy` **[Object][24]?** Any options accepted by
[node-spdy][29].
- `options.http2` **[Object][24]?** Any options accepted by
Expand Down
4 changes: 1 addition & 3 deletions lib/index.js
Expand Up @@ -34,9 +34,7 @@ var InternalError = errors.InternalError;
* `res.send()`.
* @param {Boolean} [options.handleUncaughtExceptions=false] - When true restify
* will use a domain to catch and respond to any uncaught
* exceptions that occur in it's handler stack.
* [pino](https://github.com/pinojs/pino) instance.
* response header, default is `restify`. Pass empty string to unset the header.
* exceptions that occur in its handler stack.
* Comes with significant negative performance impact.
* @param {Object} [options.spdy] - Any options accepted by
* [node-spdy](https://github.com/indutny/node-spdy).
Expand Down
4 changes: 1 addition & 3 deletions lib/server.js
Expand Up @@ -59,10 +59,8 @@ var sprintf = util.format;
* `res.send()`.
* @param {Boolean} [options.handleUncaughtExceptions=false] - When true restify
* will use a domain to catch and respond to any uncaught
* exceptions that occur in it's handler stack.
* exceptions that occur in its handler stack.
* Comes with significant negative performance impact.
* [pino](https://github.com/pinojs/pino) instance.
* response header, default is `restify`. Pass empty string to unset the header.
* @param {Object} [options.spdy] - Any options accepted by
* [node-spdy](https://github.com/indutny/node-spdy).
* @param {Object} [options.http2] - Any options accepted by
Expand Down

0 comments on commit 4d404d4

Please sign in to comment.