GotError.toJSON()

[mfulton26]

What problem are you trying to solve?

Easier serialization of errors for logging purposes.

Describe the feature

axios recently implemented toJSON() on AxiosError (axios/axios#1625).

This is super handy when logging errors as AxiosError gets stringified in JSON loggers (e.g. bunyan) to a very sensible subset of all that the error and the request/response include.

Example JSON.stringify(axiosError):

{
  "message": "Request failed with status code 404",
  "name": "Error",
  "stack": "Error: Request failed with status code 404\n    at createError…",
  "config": {
    "url": "https://www.google.com/foo",
    "headers": {
      "Accept": "application/json, text/plain, */*",
      "User-Agent": "axios/0.19.2"
    },
    "transformRequest": [null],
    "transformResponse": [null],
    "timeout": 0,
    "xsrfCookieName": "XSRF-TOKEN",
    "xsrfHeaderName": "X-XSRF-TOKEN",
    "maxContentLength": -1,
    "method": "get"
  }
}

Example JSON.stringify(gotError):

{ "name": "HTTPError" }

Checklist

• I have read the documentation and made sure this feature doesn't already exist.

[szmarczak]

Easier serialization of errors for logging purposes.

What information do you expect to serialize? The options property is not enumerable on purpose to prevent the leak of tokens etc.

[szmarczak]

Possible duplicate of #559

[szmarczak]

I think it'd be best to override .toJSON via a beforeError hook.

[szmarczak]

Duplicate of #1067