AxiosAdapter | auth-toolbox

Wraps instance of Axios client into a ClientAdapter to support automated authentication.

It should be given to Auth constructor.

Hierarchy

AxiosAdapter

Implements

ClientAdapter<AxiosResponse>

Index

Constructors

constructor

Methods

Constructors

constructor

new AxiosAdapter(axios: AxiosInstance, config?: AxiosRequestConfig): AxiosAdapter

- Defined in client-adapter/axios-adapter.ts:11
Parameters
- axios: AxiosInstance
- config: AxiosRequestConfig = {}
Returns AxiosAdapter

Methods

asRequest

asRequest(request: AxiosRequestConfig): Request

- Defined in client-adapter/axios-adapter.ts:59
Parameters
- request: AxiosRequestConfig
Returns Request

asResponse

asResponse(response: AxiosResponse): Response

- Defined in client-adapter/axios-adapter.ts:45
Parameters
- response: AxiosResponse
Returns Response

login

login(request: Request): Promise<AxiosResponse>

Implementation of ClientAdapter.login
- Defined in client-adapter/axios-adapter.ts:18
Parameters
- request: Request
Returns Promise<AxiosResponse>

logout

logout(request: Request): Promise<AxiosResponse>

Implementation of ClientAdapter.logout
- Defined in client-adapter/axios-adapter.ts:25
Parameters
- request: Request
Returns Promise<AxiosResponse>

renew

renew(request: Request): Promise<AxiosResponse>

Implementation of ClientAdapter.renew
- Defined in client-adapter/axios-adapter.ts:32
Parameters
- request: Request
Returns Promise<AxiosResponse>

request

request(request: Request): Promise<AxiosResponse>

Implementation of ClientAdapter.request
- Defined in client-adapter/axios-adapter.ts:39
Parameters
- request: Request
Returns Promise<AxiosResponse>

setupErrorResponseInterceptor

setupErrorResponseInterceptor(interceptor: ResponseInterceptor): () => void

Implementation of ClientAdapter.setupErrorResponseInterceptor
- Defined in client-adapter/axios-adapter.ts:88
Parameters
- interceptor: ResponseInterceptor
Returns () => void
- - (): void
  - Returns void

setupRequestInterceptor

setupRequestInterceptor(interceptor: RequestInterceptor): () => void

Implementation of ClientAdapter.setupRequestInterceptor
- Defined in client-adapter/axios-adapter.ts:74
Parameters
- interceptor: RequestInterceptor
Returns () => void
- - (): void
  - Returns void

Generated using TypeDoc