Skip to content

Commit dd31ede

Browse files
committed
doc: update list of deprecated / removed error codes
1 parent 9b53c58 commit dd31ede

File tree

1 file changed

+225
-2
lines changed

1 file changed

+225
-2
lines changed

doc/api/errors.md

Lines changed: 225 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1851,11 +1851,14 @@ A module file could not be resolved while attempting a [`require()`][] or
18511851
<a id="legacy-nodejs-error-codes"></a>
18521852
## Legacy Node.js Error Codes
18531853

1854+
> Stability: 0 - Deprecated. These error codes are either inconsistent, or have
1855+
> been removed.
1856+
18541857
<a id="ERR_FS_WATCHER_ALREADY_STARTED"></a>
18551858
### ERR_FS_WATCHER_ALREADY_STARTED
18561859
<!-- YAML
18571860
added: v10.0.0
1858-
removed: v10.8.0
1861+
removed: v10.0.0
18591862
-->
18601863
An attempt was made to start a watcher returned by `fs.watch()` that has
18611864
already been started.
@@ -1864,12 +1867,231 @@ already been started.
18641867
### ERR_FS_WATCHER_NOT_STARTED
18651868
<!-- YAML
18661869
added: v10.0.0
1867-
removed: v10.8.0
1870+
removed: v10.0.0
18681871
-->
18691872

18701873
An attempt was made to initiate operations on a watcher returned by
18711874
`fs.watch()` that has not yet been started.
18721875

1876+
<a id="ERR_HTTP2_ALREADY_SHUTDOWN"></a>
1877+
### ERR_HTTP2_ALREADY_SHUTDOWN
1878+
<!-- YAML
1879+
added: v10.0.0
1880+
removed: v10.0.0
1881+
-->
1882+
1883+
Occurs with multiple attempts to shutdown an HTTP/2 session.
1884+
1885+
<a id="ERR_HTTP2_ERROR"></a>
1886+
### ERR_HTTP2_ERROR
1887+
<!-- YAML
1888+
added: v9.0.0
1889+
removed: v9.0.0
1890+
-->
1891+
1892+
A non-specific HTTP/2 error has occurred.
1893+
1894+
<a id="ERR_HTTP2_FRAME_ERROR"></a>
1895+
### ERR_HTTP2_FRAME_ERROR
1896+
<!-- YAML
1897+
added: v9.0.0
1898+
removed: v10.0.0
1899+
-->
1900+
1901+
Used when a failure occurs sending an individual frame on the HTTP/2
1902+
session.
1903+
1904+
<a id="ERR_HTTP2_HEADERS_OBJECT"></a>
1905+
### ERR_HTTP2_HEADERS_OBJECT
1906+
<!-- YAML
1907+
added: v9.0.0
1908+
removed: v10.0.0
1909+
-->
1910+
1911+
Used when an HTTP/2 Headers Object is expected.
1912+
1913+
<a id="ERR_HTTP2_HEADER_REQUIRED"></a>
1914+
### ERR_HTTP2_HEADER_REQUIRED
1915+
<!-- YAML
1916+
added: v9.0.0
1917+
removed: v10.0.0
1918+
-->
1919+
1920+
Used when a required header is missing in an HTTP/2 message.
1921+
1922+
<a id="ERR_HTTP2_INFO_HEADERS_AFTER_RESPOND"></a>
1923+
### ERR_HTTP2_INFO_HEADERS_AFTER_RESPOND
1924+
<!-- YAML
1925+
added: v9.0.0
1926+
removed: v10.0.0
1927+
-->
1928+
1929+
HTTP/2 Informational headers must only be sent *prior* to calling the
1930+
`Http2Stream.prototype.respond()` method.
1931+
1932+
<a id="ERR_HTTP2_STREAM_CLOSED"></a>
1933+
### ERR_HTTP2_STREAM_CLOSED
1934+
<!-- YAML
1935+
added: v9.0.0
1936+
removed: v10.0.0
1937+
-->
1938+
1939+
Used when an action has been performed on an HTTP/2 Stream that has already
1940+
been closed.
1941+
1942+
<a id="ERR_HTTP_INVALID_CHAR"></a>
1943+
### ERR_HTTP_INVALID_CHAR
1944+
<!-- YAML
1945+
added: v9.0.0
1946+
removed: v10.0.0
1947+
-->
1948+
1949+
Used when an invalid character is found in an HTTP response status message
1950+
(reason phrase).
1951+
1952+
<a id="ERR_INVALID_ARRAY_LENGTH"></a>
1953+
### ERR_INVALID_ARRAY_LENGTH
1954+
<!-- YAML
1955+
added: v9.0.0
1956+
removed: REPLACEME
1957+
-->
1958+
1959+
Used when an Array is not of the expected length or in a valid range.
1960+
1961+
<a id="ERR_INVALID_DOMAIN_NAME"></a>
1962+
### ERR_INVALID_DOMAIN_NAME
1963+
<!-- YAML
1964+
added: v9.0.0
1965+
removed: REPLACEME
1966+
-->
1967+
1968+
Used when `hostname` can not be parsed from a provided URL.
1969+
1970+
<a id="ERR_INVALID_REPL_HISTORY"></a>
1971+
### ERR_INVALID_REPL_HISTORY
1972+
<!-- YAML
1973+
added: v9.0.0
1974+
removed: v9.0.0
1975+
-->
1976+
1977+
Used in the `repl` in case the old history file is used and an error occurred
1978+
while trying to read and parse it.
1979+
1980+
<a id="ERR_MISSING_DYNAMIC_INSTANTIATE_HOOK"></a>
1981+
### ERR_MISSING_DYNAMIC_INSTANTIATE_HOOK
1982+
<!-- YAML
1983+
added: v10.0.0
1984+
removed: v10.0.0
1985+
-->
1986+
1987+
Used when an [ES6 module][] loader hook specifies `format: 'dynamic'` but does
1988+
not provide a `dynamicInstantiate` hook.
1989+
1990+
<a id="ERR_NAPI_CONS_PROTOTYPE_OBJECT"></a>
1991+
### ERR_NAPI_CONS_PROTOTYPE_OBJECT
1992+
<!-- YAML
1993+
added: v9.0.0
1994+
removed: v10.0.0
1995+
-->
1996+
1997+
Used by the `N-API` when `Constructor.prototype` is not an object.
1998+
1999+
<a id="ERR_OUTOFMEMORY"></a>
2000+
### ERR_OUTOFMEMORY
2001+
<!-- YAML
2002+
added: v9.0.0
2003+
removed: v10.0.0
2004+
-->
2005+
2006+
Used generically to identify that an operation caused an out of memory
2007+
condition.
2008+
2009+
<a id="ERR_PARSE_HISTORY_DATA"></a>
2010+
### ERR_PARSE_HISTORY_DATA
2011+
<!-- YAML
2012+
added: v9.0.0
2013+
removed: v10.0.0
2014+
-->
2015+
2016+
The `repl` module was unable parse data from the REPL history file.
2017+
2018+
<a id="ERR_STREAM_HAS_STRINGDECODER"></a>
2019+
### ERR_STREAM_HAS_STRINGDECODER
2020+
<!-- YAML
2021+
added: v9.0.0
2022+
removed: v9.0.0
2023+
-->
2024+
2025+
Used to prevent an abort if a string decoder was set on the Socket.
2026+
2027+
Example
2028+
```js
2029+
const Socket = require('net').Socket;
2030+
const instance = new Socket();
2031+
2032+
instance.setEncoding('utf-8');
2033+
```
2034+
2035+
<a id="ERR_STREAM_READ_NOT_IMPLEMENTED"></a>
2036+
### ERR_STREAM_READ_NOT_IMPLEMENTED
2037+
<!-- YAML
2038+
added: v9.0.0
2039+
removed: v10.0.0
2040+
-->
2041+
2042+
Used when an attempt is made to use a readable stream that has not implemented
2043+
[`readable._read()`][].
2044+
2045+
<a id="ERR_STRING_TOO_LARGE"></a>
2046+
### ERR_STRING_TOO_LARGE
2047+
<!-- YAML
2048+
added: v10.0.0
2049+
removed: v10.0.0
2050+
-->
2051+
2052+
An attempt has been made to create a string larger than the maximum allowed
2053+
size.
2054+
2055+
<a id="ERR_TLS_RENEGOTIATION_FAILED"></a>
2056+
### ERR_TLS_RENEGOTIATION_FAILED
2057+
<!-- YAML
2058+
added: v9.0.0
2059+
removed: v10.0.0
2060+
-->
2061+
2062+
Used when a TLS renegotiation request has failed in a non-specific way.
2063+
2064+
<a id="ERR_UNKNOWN_BUILTIN_MODULE"></a>
2065+
### ERR_UNKNOWN_BUILTIN_MODULE
2066+
<!-- YAML
2067+
added: v8.0.0
2068+
removed: v9.0.0
2069+
-->
2070+
2071+
The `'ERR_UNKNOWN_BUILTIN_MODULE'` error code is used to identify a specific
2072+
kind of internal Node.js error that should not typically be triggered by user
2073+
code. Instances of this error point to an internal bug within the Node.js
2074+
binary itself.
2075+
2076+
<a id="ERR_VALUE_OUT_OF_RANGE"></a>
2077+
### ERR_VALUE_OUT_OF_RANGE
2078+
<!-- YAML
2079+
added: v9.0.0
2080+
removed: v10.0.0
2081+
-->
2082+
2083+
Used when a given value is out of the accepted range.
2084+
2085+
<a id="ERR_ZLIB_BINDING_CLOSED"></a>
2086+
### ERR_ZLIB_BINDING_CLOSED
2087+
<!-- YAML
2088+
added: v9.0.0
2089+
removed: v10.0.0
2090+
-->
2091+
2092+
Used when an attempt is made to use a `zlib` object after it has already been
2093+
closed.
2094+
18732095
[`--force-fips`]: cli.html#cli_force_fips
18742096
[`'uncaughtException'`]: process.html#process_event_uncaughtexception
18752097
[`child_process`]: child_process.html
@@ -1897,6 +2119,7 @@ An attempt was made to initiate operations on a watcher returned by
18972119
[`new URLSearchParams(iterable)`]: url.html#url_constructor_new_urlsearchparams_iterable
18982120
[`process.send()`]: process.html#process_process_send_message_sendhandle_options_callback
18992121
[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn
2122+
[`readable._read()`]: stream.html#stream_readable_read_size_1
19002123
[`require()`]: modules.html#modules_require
19012124
[`require('crypto').setEngine()`]: crypto.html#crypto_crypto_setengine_engine_flags
19022125
[`server.listen()`]: net.html#net_server_listen

0 commit comments

Comments
 (0)