docs: document missing error types in Errors.md#5339
Open
cesarvspr wants to merge 1 commit into
Open
Conversation
The errors table was missing several error classes that are exported from `undici`'s `errors` key: AbortError, RequestRetryError, ResponseError, MaxOriginsReachedError, BalancedPoolMissingUpstreamError, Socks5ProxyError and HTTPParserError. Add them with their codes and descriptions, matching the definitions in lib/core/errors.js.
cesarvspr
force-pushed
the
docs/document-missing-error-types
branch
from
b06ddff to
76c33c9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/docs/api/Errors.mdlists the error objects exposed via theerrorskey, but several exported error classes were missing from the table. This PR adds them, with codes and descriptions matching their definitions inlib/core/errors.js.Added entries:
AbortErrorUND_ERR_ABORTRequestRetryErrorUND_ERR_REQ_RETRYResponseErrorUND_ERR_RESPONSEMaxOriginsReachedErrorUND_ERR_MAX_ORIGINS_REACHEDBalancedPoolMissingUpstreamErrorUND_ERR_BPL_MISSING_UPSTREAMSocks5ProxyErrorUND_ERR_SOCKS5*HTTPParserErrorHPE_*Notes:
HTTPParserErrorextendsError(notUndiciError) and usesHPE_*codes; this is called out in the description so it doesn't contradict the "all errors below are extended fromUndiciError" note.Socks5ProxyErrorusesUND_ERR_SOCKS5*codes (e.g.UND_ERR_SOCKS5,UND_ERR_SOCKS5_AUTH_REJECTED).Docs-only change; no code affected.