Class AxiosPrometheus`Abstract`

Description

Axios-prometheus HTTP interface

Features:

Metrics of you HTTP requests out of the box

Example

import { container, Types } from '@biorate/inversion';
import { IConfig, Config } from '@biorate/config';
import { AxiosPrometheus } from '@biorate/axios-prometheus';

export class Google extends AxiosPrometheus {
  public baseURL = this.config.get<string>('baseURL');
  public url = '/';
  public method = 'get';
  public timeout = 1500;
}

container.bind(Types.Config).to(Config).inSingletonScope();

container.get<IConfig>(Types.Config).merge({
  baseURL: 'https://google.com',
});

(async () => {
  await Google.fetch();
})();

Hierarchy (view full)

Axios
- AxiosPrometheus

Index

Constructors

`Protected` constructor

new AxiosPrometheus(): AxiosPrometheus
Returns AxiosPrometheus
Inherited from Axios.constructor
- Defined in packages/@biorate/singleton/src/index.ts:31

Properties

`Private` #client

#client: AxiosInstance

Description

Axios client cache

`Abstract` baseURL

baseURL: string

`Protected` counter

counter: Counter<string>

`Abstract` method

method: string

timeout

timeout: number = 15000

Description

Default timeout limit

`Abstract` url

url: string

`Static` `Private` #histogram

#histogram: Histogram<string>

`Static` `Protected` cache

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

`Static` `Protected` mockFields

mockFields: string[] = ...

`Static` `Protected` mocks

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

Type declaration

value: boolean

Description

Axios instance cache

Accessors

`Protected` config

get config(): IConfig
Returns IConfig
- Defined in packages/@biorate/axios-prometheus/src/index.ts:149

`Protected` histogram

get histogram(): Histogram<string>
Returns Histogram<string>
- Defined in packages/@biorate/axios-prometheus/src/index.ts:134

`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
Inherited from Axios.defaults
- Defined in packages/@biorate/axios/src/index.ts:91

`Static` options

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

`Static` `Protected` stubs

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

Methods

`Protected` after

after(result, startTime, params): Promise<void>
Parameters
- result: AxiosResponse<any, any, {}>
- startTime: [number, number]
- params: IAxiosFetchOptions
Returns Promise<void>
Description
After hook
Overrides Axios.after
- Defined in packages/@biorate/axios-prometheus/src/index.ts:235

`Protected` before

before(params?): Promise<void>
Parameters
- Optional params: IAxiosFetchOptions
Returns Promise<void>
Description
Before hook
Overrides Axios.before
- Defined in packages/@biorate/axios-prometheus/src/index.ts:221

`Protected` catch

catch(e, startTime, params): Promise<void>
Parameters
- e: Error | AxiosError<unknown, any>
- startTime: [number, number]
- params: IAxiosFetchOptions
Returns Promise<void>
Description
Catch hook
Overrides Axios.catch
- Defined in packages/@biorate/axios-prometheus/src/index.ts:250

`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
Inherited from Axios.fetch
- Defined in packages/@biorate/axios/src/index.ts:138

`Protected` finally

finally(startTime, params?): Promise<void>
Parameters
- startTime: [number, number]
- Optional params: IAxiosFetchOptions
Returns Promise<void>
Description
Finally hook
Inherited from Axios.finally
- Defined in packages/@biorate/axios/src/index.ts:197

`Protected` fullUrl

fullUrl(params?): string
Parameters
- Optional params: IAxiosFetchOptions
Returns string
Description
Get full url = baseURL + url
- Defined in packages/@biorate/axios-prometheus/src/index.ts:217

`Protected` getStartTime

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

`Protected` log

log(statusCode, startTime): void
Parameters
- statusCode: number
- startTime: [number, number]
Returns void
Description
Log method
- Defined in packages/@biorate/axios-prometheus/src/index.ts:174

`Protected` needTrace

needTrace(url, span?): boolean
Parameters
- url: string
- Optional span: Span
Returns boolean
Description
Check need to trace
- Defined in packages/@biorate/axios-prometheus/src/index.ts:202

`Protected` stringify

stringify(data): string
Parameters
- data: unknown
Returns string
Description
Stringify data
- Defined in packages/@biorate/axios-prometheus/src/index.ts:196

`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
Inherited from Axios._fetch
- Defined in packages/@biorate/axios/src/index.ts:114

`Static` `Protected` checkMockDir

checkMockDir(directory): string
Parameters
- directory: string
Returns string
- Defined in packages/@biorate/axios-prometheus/src/index.ts:52

`Static` fetch

fetch(options?): Promise<AxiosResponse<any, any, {}>>
Parameters
- Optional options: any
Returns Promise<AxiosResponse<any, any, {}>>
Description
Fetch static method
Inherited from Axios.fetch
- 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
Overrides Axios.getMock
- Defined in packages/@biorate/axios-prometheus/src/index.ts:78

`Static` `Protected` getMockData

getMockData(instance, filename): any
Parameters
- instance: Axios
- filename: string
Returns any
- Defined in packages/@biorate/axios-prometheus/src/index.ts:74

`Static` `Protected` instance

instance<T>(): T
Type Parameters
- T
Returns T
Inherited from Axios.instance
- Defined in packages/@biorate/singleton/src/index.ts:24

`Static` `Protected` mockFileName

mockFileName(name): string
Parameters
- name: string
Returns string
- Defined in packages/@biorate/axios-prometheus/src/index.ts:48

`Static` `Protected` mockFilePath

mockFilePath(filename?): string
Parameters
- Optional filename: string
Returns string
- Defined in packages/@biorate/axios-prometheus/src/index.ts:63

`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
Overrides Axios.setMock
- Defined in packages/@biorate/axios-prometheus/src/index.ts:97

`Static` stub

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

`Static` unstub

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

`Static` useMock

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

Class AxiosPrometheusAbstract

Description

Features:

Example

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Returns AxiosPrometheus

Properties

Private #client

Description

Abstract baseURL

Protected counter

Abstract method

timeout

Description

Abstract url

Static Private #histogram

Static Protected cache

Static Protected mockFields

Static Protected mocks

Type declaration

value: boolean

Description

Accessors

Protected config

Returns IConfig

Protected histogram

Returns Histogram<string>

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

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 fullUrl

Parameters

Returns string

Description

Protected getStartTime

Returns [number, number]

Description

Protected log

Parameters

Returns void

Description

Protected needTrace

Parameters

Returns boolean

Description

Class AxiosPrometheus`Abstract`

`Protected` constructor

`Private` #client

`Abstract` baseURL

`Protected` counter

`Abstract` method

`Abstract` url

`Static` `Private` #histogram

`Static` `Protected` cache

`Static` `Protected` mockFields

`Static` `Protected` mocks

`Protected` config

`Protected` histogram

`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` fullUrl

`Protected` getStartTime

`Protected` log

`Protected` needTrace

`Protected` stringify

`Static` `Protected` _fetch

`Static` `Protected` checkMockDir

`Static` fetch

`Static` `Protected` getMock

`Static` `Protected` getMockData

`Static` `Protected` instance

`Static` `Protected` mockFileName

`Static` `Protected` mockFilePath

`Static` `Protected` setMock

`Static` stub

`Static` unstub

`Static` useMock