Interface IHttpFilter

A filter for requests and responses. can be used to modify the request/response before it is sent/received

Hierarchy

IHttpFilter

Implemented by

BasicAuthenticationFilter

Index

Methods

Methods

canHandleRequestAsync

canHandleRequestAsync(request: IHttpRequest): Promise<boolean>

- Defined in src/interfaces/HttpClientInterfaces.ts:94
determin if this filter can handle the request

Parameters
- request: IHttpRequest
  
  the request
Returns Promise<boolean>

Returns true if the filter can handle the request

canHandleResponseAsync

canHandleResponseAsync(response: IHttpResponse): Promise<boolean>

- Defined in src/interfaces/HttpClientInterfaces.ts:88
determin if this filter can handle the response

Parameters
- response: IHttpResponse
  
  the response
Returns Promise<boolean>

Returns true if the filter can handle the response

handleRequestAsync

handleRequestAsync(request: IHttpRequest): Promise<boolean | void>

- Defined in src/interfaces/HttpClientInterfaces.ts:106
handles the request

Parameters
- request: IHttpRequest
  
  the request
Returns Promise<boolean | void>

Returns true if the request should be cancelled.

handleResponseAsync

handleResponseAsync(response: IHttpResponse): Promise<boolean | void>

- Defined in src/interfaces/HttpClientInterfaces.ts:100
handles the response

Parameters
- response: IHttpResponse
  
  the response
Returns Promise<boolean | void>

Returns true if the response should be cancelled.

Generated using TypeDoc