Interface HttpInterceptor

Interceptor hooks registered through $httpProvider.interceptors.

Request hooks run in registration order. Response hooks run in reverse order. Each hook may return the value directly or return a promise.

interface HttpInterceptor {
    request?(config: RequestConfig): RequestConfig | Promise<RequestConfig>;
    requestError?(rejection: unknown): RequestConfig | Promise<RequestConfig>;
    response?<T>(
        response: HttpResponse<T>,
    ): HttpResponse<T> | Promise<HttpResponse<T>>;
    responseError?<T>(
        rejection: unknown,
    ): HttpResponse<T> | Promise<HttpResponse<T>>;
}

Index

Methods

request? requestError? response? responseError?

Methods

`Optional`request

request?(config: RequestConfig): RequestConfig | Promise<RequestConfig>
Inspect or replace the request config before transport.
Parameters
- config: RequestConfig
Returns RequestConfig | Promise<RequestConfig>

`Optional`requestError

requestError?(rejection: unknown): RequestConfig | Promise<RequestConfig>
Recover from a previous request interceptor failure.
Parameters
- rejection: unknown
Returns RequestConfig | Promise<RequestConfig>

`Optional`response

response?<T>(
response: HttpResponse<T>,
): HttpResponse<T> | Promise<HttpResponse<T>>
Inspect or replace a successful response.
Type Parameters
- T
Parameters
- response: HttpResponse<T>
Returns HttpResponse<T> | Promise<HttpResponse<T>>

`Optional`responseError

responseError?<T>(
rejection: unknown,
): HttpResponse<T> | Promise<HttpResponse<T>>
Recover from a transport error or non-2xx response.
Type Parameters
- T
Parameters
- rejection: unknown
Returns HttpResponse<T> | Promise<HttpResponse<T>>

Settings

Member Visibility

Theme