Class: ResponseBodyError

March 19, 2026 Ā· View on GitHub

šŸ’— Help the project

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

Throw when a server responds with an "OAuth-style" error JSON body

Example

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache

{
  "error": "invalid_request"
}

Properties

cause

ā€¢ cause: Record<string, JsonValue | undefined>

The parsed JSON response body

code

ā€¢ code: "OAUTH_RESPONSE_BODY_ERROR"

error

ā€¢ error: string

Error code given in the JSON response

response

ā€¢ response: Response

The "OAuth-style" error Response, its Response.bodyUsed is true and the JSON body is available in ResponseBodyError.cause

status

ā€¢ status: number

HTTP Status Code of the response

error_description?

ā€¢ optional error_description?: string

Human-readable text providing additional information, used to assist the developer in understanding the error that occurred, given in the JSON response