8-errors.md

> Back to homepage

Errors

Source code:

• source/core/errors.ts
• source/as-promise/types.ts
• source/core/response.ts

All Got errors contain various metadata, such as:

• code - A string like ERR_NON_2XX_3XX_RESPONSE,
• options - An instance of Options,
• request - An instance of Got Stream,
• response (optional) - An instance of Got Response,
• timings (optional) - Points to response.timings.

Note:

• The error.stack property may look incomplete due to the execution in an async function that is triggered by a timer.
• See https://stackoverflow.com/questions/54914770/is-there-a-good-way-to-surface-error-traces-in-production-across-event-emitters

Note:

• The error codes may differ when the root error has a code property set.

RequestError

Code: ERR_GOT_REQUEST_ERROR

When a request fails. Contains a code property with error class code, like ECONNREFUSED. All the errors below inherit this one.

CacheError

Code: ERR_CACHE_ACCESS

When a cache method fails, for example, if the database goes down or there's a filesystem error.

ReadError

Code: ERR_READING_RESPONSE_STREAM

When reading from response stream fails.

ParseError

Code: ERR_BODY_PARSE_FAILURE

When server response code is 2xx, and parsing body fails. Includes a response property.

UploadError

Code: ERR_UPLOAD

When the request body is a stream and an error occurs while reading from that stream.

HTTPError

Code: ERR_NON_2XX_3XX_RESPONSE

When the request is unsuccessful.

A request is successful when the status code of the final request is 2xx or 3xx.

When following redirects, a request is successful only when the status code of the final request is 2xx.

Note:

• 304 responses are always considered successful.

MaxRedirectsError

Code: ERR_TOO_MANY_REDIRECTS

When the server redirects you more than ten times. Includes a response property.

UnsupportedProtocolError

Note:

• This error is not public.

Code: ERR_UNSUPPORTED_PROTOCOL

When given an unsupported protocol.

TimeoutError

Code: ETIMEDOUT

When the request is aborted due to a timeout. Includes an event (a string) property along with timings.

CancelError

Code: ERR_CANCELED

When the request is aborted with promise.cancel().

RetryError

Code: ERR_RETRYING

Always triggers a new retry when thrown.