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

doc: document removed error codes

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/22100
Fixes: https://github.com/nodejs/node/issues/22061
Refs: https://github.com/nodejs/node/pull/21491
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
This commit is contained in:
Sarat Addepalli 2018-08-02 12:28:19 +05:30 committed by Vse Mozhet Byt
parent c917540f22
commit e9876fd4f1
1 changed files with 199 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

199
doc/api/errors.md
View File

@ -1848,6 +1848,204 @@ Creation of a [`zlib`][] object failed due to incorrect configuration.
A module file could not be resolved while attempting a [`require()`][] or
`import` operation.
## Legacy Node.js Error Codes
> Stability: 0 - Deprecated. These error codes are either inconsistent, or have
> been removed.
<a id="ERR_HTTP2_FRAME_ERROR"></a>
### ERR_HTTP2_FRAME_ERROR
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
Used when a failure occurs sending an individual frame on the HTTP/2
session.
<a id="ERR_HTTP2_HEADERS_OBJECT"></a>
### ERR_HTTP2_HEADERS_OBJECT
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
Used when an HTTP/2 Headers Object is expected.
<a id="ERR_HTTP2_HEADER_REQUIRED"></a>
### ERR_HTTP2_HEADER_REQUIRED
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
Used when a required header is missing in an HTTP/2 message.
<a id="ERR_HTTP2_INFO_HEADERS_AFTER_RESPOND"></a>
### ERR_HTTP2_INFO_HEADERS_AFTER_RESPOND
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
HTTP/2 informational headers must only be sent *prior* to calling the
`Http2Stream.prototype.respond()` method.
<a id="ERR_HTTP2_STREAM_CLOSED"></a>
### ERR_HTTP2_STREAM_CLOSED
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
Used when an action has been performed on an HTTP/2 Stream that has already
been closed.
<a id="ERR_HTTP_INVALID_CHAR"></a>
### ERR_HTTP_INVALID_CHAR
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
Used when an invalid character is found in an HTTP response status message
(reason phrase).
<a id="ERR_NAPI_CONS_PROTOTYPE_OBJECT"></a>
### ERR_NAPI_CONS_PROTOTYPE_OBJECT
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
Used by the `N-API` when `Constructor.prototype` is not an object.
<a id="ERR_OUTOFMEMORY"></a>
### ERR_OUTOFMEMORY
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
Used generically to identify that an operation caused an out of memory
condition.
<a id="ERR_PARSE_HISTORY_DATA"></a>
### ERR_PARSE_HISTORY_DATA
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
The `repl` module was unable to parse data from the REPL history file.
<a id="ERR_STREAM_READ_NOT_IMPLEMENTED"></a>
### ERR_STREAM_READ_NOT_IMPLEMENTED
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
Used when an attempt is made to use a readable stream that has not implemented
[`readable._read()`][].
<a id="ERR_TLS_RENEGOTIATION_FAILED"></a>
### ERR_TLS_RENEGOTIATION_FAILED
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
Used when a TLS renegotiation request has failed in a non-specific way.
<a id="ERR_UNKNOWN_BUILTIN_MODULE"></a>
### ERR_UNKNOWN_BUILTIN_MODULE
<!-- YAML
added: v8.0.0
removed: v9.0.0
-->
The `'ERR_UNKNOWN_BUILTIN_MODULE'` error code is used to identify a specific
kind of internal Node.js error that should not typically be triggered by user
code. Instances of this error point to an internal bug within the Node.js
binary itself.
<a id="ERR_VALUE_OUT_OF_RANGE"></a>
### ERR_VALUE_OUT_OF_RANGE
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
Used when a given value is out of the accepted range.
<a id="ERR_ZLIB_BINDING_CLOSED"></a>
### ERR_ZLIB_BINDING_CLOSED
<!-- YAML
added: v9.0.0
removed: v10.0.0
-->
Used when an attempt is made to use a `zlib` object after it has already been
closed.
### Other error codes
These errors have never been released, but had been present on master between
releases.
<a id="ERR_FS_WATCHER_ALREADY_STARTED"></a>
#### ERR_FS_WATCHER_ALREADY_STARTED
An attempt was made to start a watcher returned by `fs.watch()` that has
already been started.
<a id="ERR_FS_WATCHER_NOT_STARTED"></a>
#### ERR_FS_WATCHER_NOT_STARTED
An attempt was made to initiate operations on a watcher returned by
`fs.watch()` that has not yet been started.
<a id="ERR_HTTP2_ALREADY_SHUTDOWN"></a>
#### ERR_HTTP2_ALREADY_SHUTDOWN
Occurs with multiple attempts to shutdown an HTTP/2 session.
<a id="ERR_HTTP2_ERROR"></a>
#### ERR_HTTP2_ERROR
A non-specific HTTP/2 error has occurred.
<a id="ERR_INVALID_REPL_HISTORY"></a>
#### ERR_INVALID_REPL_HISTORY
Used in the `repl` in case the old history file is used and an error occurred
while trying to read and parse it.
<a id="ERR_MISSING_DYNAMIC_INSTANTIATE_HOOK"></a>
#### ERR_MISSING_DYNAMIC_INSTANTIATE_HOOK
Used when an [ES6 module][] loader hook specifies `format: 'dynamic'` but does
not provide a `dynamicInstantiate` hook.
<a id="ERR_STREAM_HAS_STRINGDECODER"></a>
#### ERR_STREAM_HAS_STRINGDECODER
Used to prevent an abort if a string decoder was set on the Socket.
```js
const Socket = require('net').Socket;
const instance = new Socket();
instance.setEncoding('utf8');
```
<a id="ERR_STRING_TOO_LARGE"></a>
#### ERR_STRING_TOO_LARGE
An attempt has been made to create a string larger than the maximum allowed
size.
[`--force-fips`]: cli.html#cli_force_fips
[`'uncaughtException'`]: process.html#process_event_uncaughtexception
[`child_process`]: child_process.html
@ -1875,6 +2073,7 @@ A module file could not be resolved while attempting a [`require()`][] or
[`new URLSearchParams(iterable)`]: url.html#url_constructor_new_urlsearchparams_iterable
[`process.send()`]: process.html#process_process_send_message_sendhandle_options_callback
[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn
[`readable._read()`]: stream.html#stream_readable_read_size_1
[`require()`]: modules.html#modules_require
[`require('crypto').setEngine()`]: crypto.html#crypto_crypto_setengine_engine_flags
[`server.listen()`]: net.html#net_server_listen