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

Singleton
- Axios

Index

Constructors

`Protected` constructor

new Axios(): Axios
Returns Axios
Inherited from Singleton.constructor
- Defined in packages/@biorate/singleton/dist/types/src/index.d.ts:4

Properties

`Private` #client

#client: AxiosInstance

Description

Axios client cache

timeout

timeout: number = 15000

Description

Default timeout limit

`Static` `Protected` cache

cache: WeakMap<typeof Singleton, Singleton>

`Static` `Protected` mocks

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

Type declaration

value: boolean

Description

Axios instance cache

Accessors

`Static` defaults

get defaults(): Omit<AxiosDefaults<any>, "headers"> & {
    headers: HeadersDefaults & {
        [key: string]: AxiosHeaderValue;
    };
}
Returns Omit<AxiosDefaults<any>, "headers"> & {
    headers: HeadersDefaults & {
        [key: string]: AxiosHeaderValue;
    };
}
Description
Set defaults
- Defined in packages/@biorate/axios/src/index.ts:91

`Static` options

get options(): Options
Returns Options
Description
Stubs options cache
- Defined in packages/@biorate/axios/src/index.ts:61

`Static` `Protected` stubs

get stubs(): Stubs
Returns Stubs
Description
Stubs instance cache
- Defined in packages/@biorate/axios/src/index.ts:55

Methods

`Protected` after

after<T, D>(result, startTime, params?, meta?): Promise<void>
Type Parameters
- T = any
- D = any
Parameters
- result: AxiosResponse<T, D, {}>
- startTime: [number, number]
- Optional params: IAxiosFetchOptions
- Optional meta: Record<string, unknown>
Returns Promise<void>
Description
After hook
- Defined in packages/@biorate/axios/src/index.ts:182

`Protected` before

before(params?, meta?): Promise<void>
Parameters
- Optional params: IAxiosFetchOptions
- Optional meta: Record<string, unknown>
Returns Promise<void>
Description
Before hook
- Defined in packages/@biorate/axios/src/index.ts:178

`Protected` catch

catch(e, startTime, params?, meta?): Promise<void>
Parameters
- e: Error
- startTime: [number, number]
- Optional params: IAxiosFetchOptions
- Optional meta: Record<string, unknown>
Returns Promise<void>
Description
Catch hook
- Defined in packages/@biorate/axios/src/index.ts:191

`Protected` fetch

fetch<T, D>(options?): Promise<AxiosResponse<T, D, {}>>
Type Parameters
- T
- D
Parameters
- Optional options: IAxiosFetchOptions
Returns Promise<AxiosResponse<T, D, {}>>
Description
Fetch method
- Defined in packages/@biorate/axios/src/index.ts:138

`Protected` finally

finally(startTime, params?, meta?): Promise<void>
Parameters
- startTime: [number, number]
- Optional params: IAxiosFetchOptions
- Optional meta: Record<string, unknown>
Returns Promise<void>
Description
Finally hook
- Defined in packages/@biorate/axios/src/index.ts:200

`Protected` getStartTime

getStartTime(): [number, number]
Returns [number, number]
Description
Get start time method
- Defined in packages/@biorate/axios/src/index.ts:172

`Static` `Protected` _fetch

_fetch<T, D>(options?): Promise<AxiosResponse<T, D, {}>>
Type Parameters
- T = any
- D = any
Parameters
- Optional options: IAxiosFetchOptions
Returns Promise<AxiosResponse<T, D, {}>>
Description
Protected fetch static method
- Defined in packages/@biorate/axios/src/index.ts:114

`Static` fetch

fetch(options?): Promise<AxiosResponse<any, any, {}>>
Parameters
- Optional options: any
Returns Promise<AxiosResponse<any, any, {}>>
Description
Fetch static method
- Defined in packages/@biorate/axios/src/index.ts:67

`Static` `Protected` getMock

getMock<T, D>(instance, options?): AxiosResponse<T, D, {}>
Type Parameters
- T = any
- D = any
Parameters
- instance: Axios
- Optional options: IAxiosFetchOptions
Returns AxiosResponse<T, D, {}>
Description
Get mock static method
- Defined in packages/@biorate/axios/src/index.ts:97

`Static` `Protected` instance

instance<T>(): T
Type Parameters
- T
Returns T
Inherited from Singleton.instance
- Defined in packages/@biorate/singleton/dist/types/src/index.d.ts:3

`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
Returns void
Description
Set mock static method
- Defined in packages/@biorate/axios/src/index.ts:106

`Static` stub

stub(params, persist?): void
Parameters
- params: IStubParam
- persist: boolean = false
Returns void
Description
Stub static method
- Defined in packages/@biorate/axios/src/index.ts:73

`Static` unstub

unstub(): void
Returns void
Description
Unstub static method
- Defined in packages/@biorate/axios/src/index.ts:79

`Static` useMock

useMock(): void
Returns void
Description
Use mock static method
- Defined in packages/@biorate/axios/src/index.ts:85

Class Axios

Description

Features:

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Returns Axios

Properties

Private #client

Description

timeout

Description

Static Protected cache

Static Protected mocks

Type declaration

value: boolean

Description

Accessors

Static defaults

Returns Omit<AxiosDefaults<any>, "headers"> & { headers: HeadersDefaults & { [key: string]: AxiosHeaderValue; }; }

Description

Static options

Returns Options

Description

Static Protected stubs

Returns Stubs

Description

Methods

Protected after

Type Parameters

Parameters

Returns Promise<void>

Description

Protected before

Parameters

Returns Promise<void>

Description

Protected catch

Parameters

Returns Promise<void>

Description

Protected fetch

Type Parameters

Parameters

Returns Promise<AxiosResponse<T, D, {}>>

Description

Protected finally

Parameters

Returns Promise<void>

Description

Protected getStartTime

Returns [number, number]

Description

Static Protected _fetch

Type Parameters

Parameters

Returns Promise<AxiosResponse<T, D, {}>>

Description

Static fetch

Parameters

Returns Promise<AxiosResponse<any, any, {}>>

Description

Static Protected getMock

Type Parameters

Parameters

Returns AxiosResponse<T, D, {}>

Description

Static Protected instance

Type Parameters

Returns T

Static Protected setMock

Type Parameters

Parameters

Returns void

`Protected` constructor

`Private` #client

`Static` `Protected` cache

`Static` `Protected` mocks

`Static` defaults

Returns Omit<AxiosDefaults<any>, "headers"> & {
headers: HeadersDefaults & {
[key: string]: AxiosHeaderValue;
};
}

`Static` options

`Static` `Protected` stubs

`Protected` after

`Protected` before

`Protected` catch

`Protected` fetch

`Protected` finally

`Protected` getStartTime

`Static` `Protected` _fetch

`Static` fetch

`Static` `Protected` getMock

`Static` `Protected` instance

`Static` `Protected` setMock

`Static` stub

`Static` unstub

`Static` useMock