summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/api/process.md25
1 files changed, 21 insertions, 4 deletions
diff --git a/doc/api/process.md b/doc/api/process.md
index bbf0151e9b..cac35f2957 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