diff options
| author | Juan José Arboleda <soyjuanarbol@gmail.com> | 2019-09-08 13:30:07 -0500 |
|---|---|---|
| committer | Ruben Bridgewater <ruben@bridgewater.de> | 2019-09-25 18:21:05 +0200 |
| commit | 2707beb8b8aaa4619a28f79eeacd980d630ed85d (patch) | |
| tree | e8c792ae75f145e0420dcbacf75608bc0c198166 | |
| parent | 123437bcc370e21d24c367dec8705644214c39e3 (diff) | |
| download | node-new-2707beb8b8aaa4619a28f79eeacd980d630ed85d.tar.gz | |
doc: add code example to process.throwDeprecation property
PR-URL: https://github.com/nodejs/node/pull/29495
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
| -rw-r--r-- | doc/api/process.md | 25 |
1 files changed, 21 insertions, 4 deletions
diff --git a/doc/api/process.md b/doc/api/process.md index 3a414dad23..57b4eae02b 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -2224,11 +2224,28 @@ added: v0.9.12 * {boolean} -The `process.throwDeprecation` property indicates whether the -`--throw-deprecation` flag is set on the current Node.js process. See the +The initial value of `process.throwDeprecation` indicates whether the +`--throw-deprecation` flag is set on the current Node.js process. +`process.throwDeprecation` is mutable, so whether or not deprecation +warnings result in errors may be altered at runtime. See the documentation for the [`'warning'` event][process_warning] and the -[`emitWarning()` method][process_emit_warning] for more information about this -flag's behavior. +[`emitWarning()` method][process_emit_warning] for more information. + +```console +$ node --throw-deprecation -p "process.throwDeprecation" +true +$ node -p "process.throwDeprecation" +undefined +$ node +> process.emitWarning('test', 'DeprecationWarning'); +undefined +> (node:26598) DeprecationWarning: test +> process.throwDeprecation = true; +true +> process.emitWarning('test', 'DeprecationWarning'); +Thrown: +{ [DeprecationWarning: test] name: 'DeprecationWarning' } +``` ## process.title <!-- YAML |