Class Axios

Hierarchy (view full)

Singleton
- Axios
  - AxiosPrometheus

Index

Constructors

Properties

#private timeout cache mocks

Accessors

defaults options stubs

Methods

after before catch fetch finally getStartTime _fetch fetch getMock instance setMock stub unstub useMock

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` #private

#private: any

timeout

timeout: number

`Static` `Protected` cache

cache: WeakMap<typeof Singleton, Singleton>

`Static` `Protected` mocks

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

Type declaration

value: boolean

Accessors

`Static` defaults

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

`Static` options

get options(): Options
Returns Options
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:13

`Static` `Protected` stubs

get stubs(): Stubs
Returns Stubs
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:12

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>
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:30

`Protected` before

before(params?, meta?): Promise<void>
Parameters
- Optional params: IAxiosFetchOptions
- Optional meta: Record<string, unknown>
Returns Promise<void>
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:29

`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>
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:31

`Protected` fetch

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

`Protected` finally

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

`Protected` getStartTime

getStartTime(): [number, number]
Returns [number, number]
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:28

`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, {}>>
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:25

`Static` fetch

fetch(options?): Promise<AxiosResponse<any, any, {}>>
Parameters
- Optional options: any
Returns Promise<AxiosResponse<any, any, {}>>
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:14

`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, {}>
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:23

`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
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:24

`Static` stub

stub(params, persist?): void
Parameters
- params: IStubParam
- Optional persist: boolean
Returns void
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:15

`Static` unstub

unstub(): void
Returns void
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:16

`Static` useMock

useMock(): void
Returns void
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:17