1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: document common warning types

Browse Source 
Fixes: https://github.com/nodejs/node/issues/24987
Signed-off-by: James M Snell <jasnell@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/36713
Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
James M Snell 2020-12-31 14:53:05 -08:00
parent 83ab5433ff
commit 5499caa41e
No known key found for this signature in database
GPG Key ID: 7341B15C070877AC
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/api/process.md
View File

@ -462,6 +462,29 @@ The `*-deprecation` command-line flags only affect warnings that use the name
See the [`process.emitWarning()`][process_emit_warning] method for issuing
custom or application-specific warnings.
#### Node.js warning names
There are no strict guidelines for warning types (as identified by the `name`
property) emitted by Node.js. New types of warnings can be added at any time.
A few of the warning types that are most common include:
* `'DeprecationWarning'` - Indicates use of a deprecated Node.js API or feature.
Such warnings must include a `'code'` property identifying the
[deprecation code][].
* `'ExperimentalWarning'` - Indicates use of an experimental Node.js API or
feature. Such features must be used with caution as they may change at any
time and are not subject to the same strict semantic-versioning and long-term
support policies as supported features.
* `'MaxListenersExceededWarning'` - Indicates that too many listeners for a
given event have been registered on either an `EventEmitter` or `EventTarget`.
This is often an indication of a memory leak.
* `'TimeoutOverflowWarning'` - Indicates that a numeric value that cannot fit
within a 32-bit signed integer has been provided to either the `setTimeout()`
or `setInterval()` functions.
* `'UnsupportedWarning'` - Indicates use of an unsupported option or feature
that will be ignored rather than treated as an error. One example is use of
the HTTP response status message when using the HTTP/2 compatibility API.
### Signal events
<!--type=event-->
@ -2698,6 +2721,7 @@ cases:
[`subprocess.kill()`]: child_process.md#child_process_subprocess_kill_signal
[`v8.setFlagsFromString()`]: v8.md#v8_v8_setflagsfromstring_flags
[debugger]: debugger.md
[deprecation code]: deprecations.md
[note on process I/O]: process.md#process_a_note_on_process_i_o
[process.cpuUsage]: #process_process_cpuusage_previousvalue
[process_emit_warning]: #process_process_emitwarning_warning_type_code_ctor