diff options
author | Brian White <mscdex@mscdex.net> | 2016-11-12 23:38:29 -0500 |
---|---|---|
committer | Brian White <mscdex@mscdex.net> | 2016-11-15 21:52:10 -0500 |
commit | 5242114d89652a217880c0a0f216bf46a51c1379 (patch) | |
tree | ebcbecc98b676800003c6284da4b6d6327c19d94 /doc/api | |
parent | 71d4a7474d234bba9461e28c95841bbd090cc642 (diff) | |
download | android-node-v8-5242114d89652a217880c0a0f216bf46a51c1379.tar.gz android-node-v8-5242114d89652a217880c0a0f216bf46a51c1379.tar.bz2 android-node-v8-5242114d89652a217880c0a0f216bf46a51c1379.zip |
doc: remove redundant warning information
process.emitWarning() already describes how to emit custom warnings,
so just merely provide a link to that function from the 'warning'
event documentation.
PR-URL: https://github.com/nodejs/node/pull/9590
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Prince John Wesley <princejohnwesley@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/process.md | 49 |
1 files changed, 5 insertions, 44 deletions
diff --git a/doc/api/process.md b/doc/api/process.md index 4ea0fd864e..44db505eab 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -312,50 +312,6 @@ $ node --no-warnings The `--trace-warnings` command-line option can be used to have the default console output for warnings include the full stack trace of the warning. -#### Emitting custom warnings - -The [`process.emitWarning()`][process_emit_warning] method can be used to issue -custom or application specific warnings. - -```js -// Emit a warning using a string... -process.emitWarning('Something happened!'); - // Prints: (node 12345) Warning: Something happened! - -// Emit a warning using an object... -process.emitWarning('Something Happened!', 'CustomWarning'); - // Prints: (node 12345) CustomWarning: Something happened! - -// Emit a warning using a custom Error object... -class CustomWarning extends Error { - constructor(message) { - super(message); - this.name = 'CustomWarning'; - Error.captureStackTrace(this, CustomWarning); - } -} -const myWarning = new CustomWarning('Something happened!'); -process.emitWarning(myWarning); - // Prints: (node 12345) CustomWarning: Something happened! -``` - -#### Emitting custom deprecation warnings - -Custom deprecation warnings can be emitted by setting the `name` of a custom -warning to `DeprecationWarning`. For instance: - -```js -process.emitWarning('This API is deprecated', 'DeprecationWarning'); -``` - -Or, - -```js -const err = new Error('This API is deprecated'); -err.name = 'DeprecationWarning'; -process.emitWarning(err); -``` - Launching Node.js using the `--throw-deprecation` command line flag will cause custom deprecation warnings to be thrown as exceptions. @@ -368,6 +324,11 @@ of the custom deprecation. The `*-deprecation` command line flags only affect warnings that use the name `DeprecationWarning`. +#### Emitting custom warnings + +See the [`process.emitWarning()`][process_emit_warning] method for issuing +custom or application-specific warnings. + ### Signal Events <!--type=event--> |