Class Axios

Description

Axios OOP static interface

Features:

Example

import { Axios } from '@biorate/axios';

class Yandex extends Axios {
  public baseURL = 'https://yandex.ru';
}

(async () => {
  const response = await Yandex.fetch<string>();
  console.log(response.status); // 200
  console.log(response.data); // <!DOCTYPE html><html ...
})();

Hierarchy

Axios
- AxiosPrometheus

Index

Constructors

constructor

new Axios(): Axios
Returns Axios

Properties

`Private` #client

#client: AxiosInstance

Description

Axios client cache

`Static` `Protected` cache

cache: WeakMap<typeof Axios, Axios> = ...

Description

Axios instance cache

`Static` `Protected` mocks

mocks: WeakMap<typeof Axios, {
value: boolean;
}> = ...

Type declaration

value: boolean

Description

Axios instance cache

`Static` `Protected` stubs

stubs: WeakMap<typeof Axios, ((options?) => Promise<AxiosResponse<any, any>>)> = ...

Type declaration

- (options?): Promise<AxiosResponse<any, any>>
- Parameters
  - Optional options: any
    Optional
  Returns Promise<AxiosResponse<any, any>>

Description

Stubs instance cache

Accessors

`Static` defaults

get defaults(): AxiosDefaults<any>
Returns AxiosDefaults<any>

Description
Set defaults
- Defined in packages/@biorate/axios/src/index.ts:112

Methods

`Protected` after

after<T, D>(result, startTime, params?): Promise<void>
Type Parameters
- T = any
- D = any
Parameters
- result: AxiosResponse<T, D>
- startTime: [number, number]
- Optional params: IAxiosFetchOptions
  Optional
Returns Promise<void>

Description
After hook
- Defined in packages/@biorate/axios/src/index.ts:199

`Protected` before

before(params?): Promise<void>
Parameters
- Optional params: IAxiosFetchOptions
  Optional
Returns Promise<void>

Description
Before hook
- Defined in packages/@biorate/axios/src/index.ts:195

`Protected` catch

catch(e, startTime, params?): Promise<void>
Parameters
- e: Error
- startTime: [number, number]
- Optional params: IAxiosFetchOptions
  Optional
Returns Promise<void>

Description
Catch hook
- Defined in packages/@biorate/axios/src/index.ts:207

`Protected` fetch

fetch<T, D>(options?): Promise<AxiosResponse<T, D>>
Type Parameters
- T
- D
Parameters
- Optional options: IAxiosFetchOptions
  Optional
Returns Promise<AxiosResponse<T, D>>

Description
Fetch method
- Defined in packages/@biorate/axios/src/index.ts:156

`Protected` finally

finally(startTime, params?): Promise<void>
Parameters
- startTime: [number, number]
- Optional params: IAxiosFetchOptions
  Optional
Returns Promise<void>

Description
Finally hook
- Defined in packages/@biorate/axios/src/index.ts:215

`Protected` getStartTime

getStartTime(): [number, number]
Returns [number, number]

Description
Get start time method
- Defined in packages/@biorate/axios/src/index.ts:189

`Static` `Protected` _fetch

_fetch<T, D>(options?): Promise<AxiosResponse<T, D>>
Type Parameters
- T = any
- D = any
Parameters
- Optional options: IAxiosFetchOptions
  Optional
Returns Promise<AxiosResponse<T, D>>

Description
Protected fetch static method
- Defined in packages/@biorate/axios/src/index.ts:135

`Static` fetch

fetch(options?): Promise<AxiosResponse<any, any>>
Parameters
- Optional options: any
  Optional
Returns Promise<AxiosResponse<any, any>>

Description
Fetch static method
- Defined in packages/@biorate/axios/src/index.ts:61

`Static` `Protected` getMock

getMock<T, D>(instance, options?): AxiosResponse<T, D>
Type Parameters
- T = any
- D = any
Parameters
- instance: Axios
- Optional options: IAxiosFetchOptions
  Optional
Returns AxiosResponse<T, D>

Description
Get mock static method
- Defined in packages/@biorate/axios/src/index.ts:118

`Static` `Protected` setMock

setMock<T, D>(instance, result, options?): void
Type Parameters
- T = any
- D = any
Parameters
- instance: Axios
- result: AxiosResponse<T, D>
- Optional options: IAxiosFetchOptions
  Optional
Returns void

Description
Set mock static method
- Defined in packages/@biorate/axios/src/index.ts:127

`Static` stub

stub(params, persist?): void
Parameters
- params: {
      config?: Record<string, any>;
      data: string | Record<string, any>;
      error?: Error;
      headers?: Record<string, any>;
      status?: number;
      statusText?: string;
  }
  - Optional config?: Record<string, any>
  - data: string | Record<string, any>
  - Optional error?: Error
  - Optional headers?: Record<string, any>
  - Optional status?: number
  - Optional statusText?: string
- persist: boolean = false
Returns void

Description
Stub static method
- Defined in packages/@biorate/axios/src/index.ts:67

`Static` unstub

unstub(): void
Returns void

Description
Unstub static method
- Defined in packages/@biorate/axios/src/index.ts:99

`Static` useMock

useMock(): void
Returns void

Description
Use mock static method
- Defined in packages/@biorate/axios/src/index.ts:106

Class Axios

Description

Features:

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Axios

Properties

Private #client

Description

Static Protected cache

Description

Static Protected mocks

Type declaration

value: boolean

Description

Static Protected stubs

Type declaration

Parameters

Optional options: any

Returns Promise<AxiosResponse<any, any>>

Description

Accessors

Static defaults

Returns AxiosDefaults<any>

Description

Methods

Protected after

Type Parameters

T = any

D = any

Parameters

result: AxiosResponse<T, D>

startTime: [number, number]

Optional params: IAxiosFetchOptions

Returns Promise<void>

Description

Protected before

Parameters

Optional params: IAxiosFetchOptions

Returns Promise<void>

Description

Protected catch

Parameters

e: Error

startTime: [number, number]

Optional params: IAxiosFetchOptions

Returns Promise<void>

Description

Protected fetch

Type Parameters

T

D

Parameters

Optional options: IAxiosFetchOptions

Returns Promise<AxiosResponse<T, D>>

Description

Protected finally

Parameters

startTime: [number, number]

Optional params: IAxiosFetchOptions

Returns Promise<void>

Description

Protected getStartTime

Returns [number, number]

Description

Static Protected _fetch

Type Parameters

T = any

D = any

Parameters

Optional options: IAxiosFetchOptions

Returns Promise<AxiosResponse<T, D>>

Description

`Private` #client

`Static` `Protected` cache

`Static` `Protected` mocks

`Static` `Protected` stubs

`Optional` options: any

`Static` defaults

`Protected` after

`Optional` params: IAxiosFetchOptions

`Protected` before

`Optional` params: IAxiosFetchOptions

`Protected` catch

`Optional` params: IAxiosFetchOptions

`Protected` fetch

`Optional` options: IAxiosFetchOptions

`Protected` finally

`Optional` params: IAxiosFetchOptions

`Protected` getStartTime

`Static` `Protected` _fetch

`Optional` options: IAxiosFetchOptions

`Static` fetch

`Optional` options: any

`Static` `Protected` getMock

`Optional` options: IAxiosFetchOptions

`Static` `Protected` setMock

`Optional` options: IAxiosFetchOptions

`Static` stub

params: {
config?: Record<string, any>;
data: string | Record<string, any>;
error?: Error;
headers?: Record<string, any>;
status?: number;
statusText?: string;
}

`Optional` config?: Record<string, any>

`Optional` error?: Error

`Optional` headers?: Record<string, any>

`Optional` status?: number

`Optional` statusText?: string

`Static` unstub

`Static` useMock