From 2707beb8b8aaa4619a28f79eeacd980d630ed85d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Jos=C3=A9=20Arboleda?= Date: Sun, 8 Sep 2019 13:30:07 -0500 Subject: [PATCH] doc: add code example to process.throwDeprecation property PR-URL: https://github.com/nodejs/node/pull/29495 Reviewed-By: David Carlier Reviewed-By: James M Snell --- doc/api/process.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/doc/api/process.md b/doc/api/process.md index 3a414dad231357..57b4eae02b2faa 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