Library to redact sensitive information from Axios errors. This can be used as an response interceptor for axios instances, or can be used standalone.
Works with
axios@^0
axios@^1
npm i axios-error-redact
The redactor can simply be used in an interceptor to extract non-sensitive data from error and continue
import axios from 'axios'
import {getErrorInterceptor} from 'axios-error-redact'
const instance = axios.create({baseURL: 'http://example.com'})
instance.interceptors.response.use(undefined, getErrorInterceptor())
// instance.get()
The redactor can be used in an interceptor to extract non-sensitive data from error and continue, with this approach the interceptor can be created with some custom logic
import axios from 'axios'
import {AxiosErrorRedactor} from 'axios-error-redact'
const instance = axios.create({baseURL: 'http://example.com'})
const redactor = new AxiosErrorRedactor()
function errorInterceptor(error: any): any {
const redactedError = redactor.redactError(error)
// You may want to add more logic here; for example logging
return Promise.reject(redactedError)
}
instance.interceptors.response.use(undefined, errorInterceptor)
// instance.get()
The library can be used on its own without using any interceptor as well.
import axios from 'axios'
import {AxiosErrorRedactor} from 'axios-error-redact'
const redactor = new AxiosErrorRedactor()
const result = axios.get('http://example.com')
.catch(error => redactor.redactError(error))
The redactor object can be initiated with some defaults; in which all of the sensitive data will be redacted (request, response, query)
import {AxiosErrorRedactor} from 'axios-error-redact'
const redactor = new AxiosErrorRedactor()
The constructor also accepts boolean values to enable or disable these
import {AxiosErrorRedactor} from 'axios-error-redact'
const redactor = new AxiosErrorRedactor(
false, //redactRequestData
false, //redactResponseData
false, //redactQueryData
)
The main function that can be called on the initiated object is redactError
which accepts the error as the input and returns the redacted information in and object of type HttpErrorResponse
import axios from 'axios'
import {AxiosErrorRedactor} from 'axios-error-redact'
const redactor = new AxiosErrorRedactor()
const result = axios.get('http://example.com')
.catch(error => redactor.redactError(error))
There are three functions that can be used and chained after the initiated object in order to change what sort of data should be skipped to be redacted.
import {AxiosErrorRedactor} from 'axios-error-redact'
const redactor = new AxiosErrorRedactor().skipRequestData().skipQueryData()
The redact library will extract information from axios error and return an object with following details.
HttpErrorResponse {
message: string;
fullURL: string;
response: {
statusCode?: number;
statusMessage: string;
data: any;
};
request: {
baseURL: string;
path: string;
method: string;
data: any;
};
}
If the error is not an axios error, then the same error will be returned.