Skip to content

Commit 2875f72

Browse files
SirR4Ttargos
authored andcommitted
doc: document removed error codes
PR-URL: #22100 Fixes: #22061 Refs: #21491 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Joyee Cheung <[email protected]>
1 parent c833d83 commit 2875f72

File tree

1 file changed

+199
-0
lines changed

1 file changed

+199
-0
lines changed

doc/api/errors.md

+199
Original file line numberDiff line numberDiff line change
@@ -1842,6 +1842,204 @@ Creation of a [`zlib`][] object failed due to incorrect configuration.
18421842
A module file could not be resolved while attempting a [`require()`][] or
18431843
`import` operation.
18441844

1845+
## Legacy Node.js Error Codes
1846+
1847+
> Stability: 0 - Deprecated. These error codes are either inconsistent, or have
1848+
> been removed.
1849+
1850+
<a id="ERR_HTTP2_FRAME_ERROR"></a>
1851+
### ERR_HTTP2_FRAME_ERROR
1852+
<!-- YAML
1853+
added: v9.0.0
1854+
removed: v10.0.0
1855+
-->
1856+
1857+
Used when a failure occurs sending an individual frame on the HTTP/2
1858+
session.
1859+
1860+
<a id="ERR_HTTP2_HEADERS_OBJECT"></a>
1861+
### ERR_HTTP2_HEADERS_OBJECT
1862+
<!-- YAML
1863+
added: v9.0.0
1864+
removed: v10.0.0
1865+
-->
1866+
1867+
Used when an HTTP/2 Headers Object is expected.
1868+
1869+
<a id="ERR_HTTP2_HEADER_REQUIRED"></a>
1870+
### ERR_HTTP2_HEADER_REQUIRED
1871+
<!-- YAML
1872+
added: v9.0.0
1873+
removed: v10.0.0
1874+
-->
1875+
1876+
Used when a required header is missing in an HTTP/2 message.
1877+
1878+
<a id="ERR_HTTP2_INFO_HEADERS_AFTER_RESPOND"></a>
1879+
### ERR_HTTP2_INFO_HEADERS_AFTER_RESPOND
1880+
<!-- YAML
1881+
added: v9.0.0
1882+
removed: v10.0.0
1883+
-->
1884+
1885+
HTTP/2 informational headers must only be sent *prior* to calling the
1886+
`Http2Stream.prototype.respond()` method.
1887+
1888+
<a id="ERR_HTTP2_STREAM_CLOSED"></a>
1889+
### ERR_HTTP2_STREAM_CLOSED
1890+
<!-- YAML
1891+
added: v9.0.0
1892+
removed: v10.0.0
1893+
-->
1894+
1895+
Used when an action has been performed on an HTTP/2 Stream that has already
1896+
been closed.
1897+
1898+
<a id="ERR_HTTP_INVALID_CHAR"></a>
1899+
### ERR_HTTP_INVALID_CHAR
1900+
<!-- YAML
1901+
added: v9.0.0
1902+
removed: v10.0.0
1903+
-->
1904+
1905+
Used when an invalid character is found in an HTTP response status message
1906+
(reason phrase).
1907+
1908+
<a id="ERR_NAPI_CONS_PROTOTYPE_OBJECT"></a>
1909+
### ERR_NAPI_CONS_PROTOTYPE_OBJECT
1910+
<!-- YAML
1911+
added: v9.0.0
1912+
removed: v10.0.0
1913+
-->
1914+
1915+
Used by the `N-API` when `Constructor.prototype` is not an object.
1916+
1917+
<a id="ERR_OUTOFMEMORY"></a>
1918+
### ERR_OUTOFMEMORY
1919+
<!-- YAML
1920+
added: v9.0.0
1921+
removed: v10.0.0
1922+
-->
1923+
1924+
Used generically to identify that an operation caused an out of memory
1925+
condition.
1926+
1927+
<a id="ERR_PARSE_HISTORY_DATA"></a>
1928+
### ERR_PARSE_HISTORY_DATA
1929+
<!-- YAML
1930+
added: v9.0.0
1931+
removed: v10.0.0
1932+
-->
1933+
1934+
The `repl` module was unable to parse data from the REPL history file.
1935+
1936+
<a id="ERR_STREAM_READ_NOT_IMPLEMENTED"></a>
1937+
### ERR_STREAM_READ_NOT_IMPLEMENTED
1938+
<!-- YAML
1939+
added: v9.0.0
1940+
removed: v10.0.0
1941+
-->
1942+
1943+
Used when an attempt is made to use a readable stream that has not implemented
1944+
[`readable._read()`][].
1945+
1946+
<a id="ERR_TLS_RENEGOTIATION_FAILED"></a>
1947+
### ERR_TLS_RENEGOTIATION_FAILED
1948+
<!-- YAML
1949+
added: v9.0.0
1950+
removed: v10.0.0
1951+
-->
1952+
1953+
Used when a TLS renegotiation request has failed in a non-specific way.
1954+
1955+
<a id="ERR_UNKNOWN_BUILTIN_MODULE"></a>
1956+
### ERR_UNKNOWN_BUILTIN_MODULE
1957+
<!-- YAML
1958+
added: v8.0.0
1959+
removed: v9.0.0
1960+
-->
1961+
1962+
The `'ERR_UNKNOWN_BUILTIN_MODULE'` error code is used to identify a specific
1963+
kind of internal Node.js error that should not typically be triggered by user
1964+
code. Instances of this error point to an internal bug within the Node.js
1965+
binary itself.
1966+
1967+
<a id="ERR_VALUE_OUT_OF_RANGE"></a>
1968+
### ERR_VALUE_OUT_OF_RANGE
1969+
<!-- YAML
1970+
added: v9.0.0
1971+
removed: v10.0.0
1972+
-->
1973+
1974+
Used when a given value is out of the accepted range.
1975+
1976+
<a id="ERR_ZLIB_BINDING_CLOSED"></a>
1977+
### ERR_ZLIB_BINDING_CLOSED
1978+
<!-- YAML
1979+
added: v9.0.0
1980+
removed: v10.0.0
1981+
-->
1982+
1983+
Used when an attempt is made to use a `zlib` object after it has already been
1984+
closed.
1985+
1986+
### Other error codes
1987+
1988+
These errors have never been released, but had been present on master between
1989+
releases.
1990+
1991+
<a id="ERR_FS_WATCHER_ALREADY_STARTED"></a>
1992+
#### ERR_FS_WATCHER_ALREADY_STARTED
1993+
1994+
An attempt was made to start a watcher returned by `fs.watch()` that has
1995+
already been started.
1996+
1997+
<a id="ERR_FS_WATCHER_NOT_STARTED"></a>
1998+
#### ERR_FS_WATCHER_NOT_STARTED
1999+
2000+
An attempt was made to initiate operations on a watcher returned by
2001+
`fs.watch()` that has not yet been started.
2002+
2003+
<a id="ERR_HTTP2_ALREADY_SHUTDOWN"></a>
2004+
#### ERR_HTTP2_ALREADY_SHUTDOWN
2005+
2006+
Occurs with multiple attempts to shutdown an HTTP/2 session.
2007+
2008+
<a id="ERR_HTTP2_ERROR"></a>
2009+
#### ERR_HTTP2_ERROR
2010+
2011+
A non-specific HTTP/2 error has occurred.
2012+
2013+
<a id="ERR_INVALID_REPL_HISTORY"></a>
2014+
#### ERR_INVALID_REPL_HISTORY
2015+
2016+
Used in the `repl` in case the old history file is used and an error occurred
2017+
while trying to read and parse it.
2018+
2019+
<a id="ERR_MISSING_DYNAMIC_INSTANTIATE_HOOK"></a>
2020+
#### ERR_MISSING_DYNAMIC_INSTANTIATE_HOOK
2021+
2022+
Used when an [ES6 module][] loader hook specifies `format: 'dynamic'` but does
2023+
not provide a `dynamicInstantiate` hook.
2024+
2025+
<a id="ERR_STREAM_HAS_STRINGDECODER"></a>
2026+
#### ERR_STREAM_HAS_STRINGDECODER
2027+
2028+
Used to prevent an abort if a string decoder was set on the Socket.
2029+
2030+
```js
2031+
const Socket = require('net').Socket;
2032+
const instance = new Socket();
2033+
2034+
instance.setEncoding('utf8');
2035+
```
2036+
2037+
<a id="ERR_STRING_TOO_LARGE"></a>
2038+
#### ERR_STRING_TOO_LARGE
2039+
2040+
An attempt has been made to create a string larger than the maximum allowed
2041+
size.
2042+
18452043
[`--force-fips`]: cli.html#cli_force_fips
18462044
[`'uncaughtException'`]: process.html#process_event_uncaughtexception
18472045
[`child_process`]: child_process.html
@@ -1869,6 +2067,7 @@ A module file could not be resolved while attempting a [`require()`][] or
18692067
[`new URLSearchParams(iterable)`]: url.html#url_constructor_new_urlsearchparams_iterable
18702068
[`process.send()`]: process.html#process_process_send_message_sendhandle_options_callback
18712069
[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn
2070+
[`readable._read()`]: stream.html#stream_readable_read_size_1
18722071
[`require()`]: modules.html#modules_require
18732072
[`require('crypto').setEngine()`]: crypto.html#crypto_crypto_setengine_engine_flags
18742073
[`server.listen()`]: net.html#net_server_listen

0 commit comments

Comments
 (0)