Skip to content

fix(client): serialize headers in APIError.toJSON() so rate-limit headers are visible #1837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
anishesg wants to merge 1 commit into from
+19 −0
Closed

fix(client): serialize headers in APIError.toJSON() so rate-limit headers are visible #1837

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/core/error.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,25 @@ export class APIError<
this.type = data?.['type'];
}

/**
* Returns a JSON-serializable representation of this error, with `headers`
* converted from a `Headers` instance to a plain object so that all headers
* (including rate-limit headers such as `x-ratelimit-reset-requests`) are
* visible when the error is logged or serialised with `JSON.stringify`.
*/
toJSON() {
return {
status: this.status,
headers: this.headers ? Object.fromEntries(this.headers.entries()) : undefined,
error: this.error,
code: this.code,
Comment thread
anishesg marked this conversation as resolved.
param: this.param,
type: this.type,
requestID: this.requestID,
message: this.message,
};
}

private static makeMessage(status: number | undefined, error: any, message: string | undefined) {
const msg =
error?.message ?
Expand Down