Skip to content
Permalink
Browse files
doc: document ABORT_ERR code
We added an `AbortError` with the same code and name as the web's as
part of the consensus in #36084 but
never actually documented the error in our error codes list.

This PR adds the error code.

PR-URL: #36319
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information
benjamingr authored and targos committed Jun 11, 2021
1 parent cd7cf05 commit b197a44152e1b8523f9dc2b26dc3de637b16ea59
Showing with 12 additions and 0 deletions.
  1. +12 −0 doc/api/errors.md
@@ -612,6 +612,18 @@ A human-readable string describing the reason for the error.
<a id="nodejs-error-codes"></a>
## Node.js error codes

<a id="ABORT_ERR"></a>
### `ABORT_ERR`
<!-- YAML
added: v14.17.0
-->
Used when an operation has been aborted (typically using an `AbortController`).

APIs _not_ using `AbortSignal`s typically do not raise an error with this code.

This code does not use the regular `ERR_*` convention Node.js errors use in
order to be compatible with the web platform's `AbortError`.

<a id="ERR_AMBIGUOUS_ARGUMENT"></a>
### `ERR_AMBIGUOUS_ARGUMENT`

0 comments on commit b197a44

Please sign in to comment.