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

Axios
- AxiosPrometheus

Index

Constructors

constructor

new AxiosPrometheus(): AxiosPrometheus
Returns AxiosPrometheus

Inherited from Axios.constructor

Properties

`Private` #client

#client: AxiosInstance

Description

Axios client cache

`Abstract` baseURL

baseURL: string

`Protected` counter

counter: Counter

`Protected` histogram

histogram: Histogram

`Abstract` method

method: string

`Abstract` url

url: string

`Static` `Protected` cache

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

Description

Axios instance cache

`Static` `Protected` mockFields

mockFields: string[] = ...

`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

`Protected` config

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

`Static` defaults

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

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

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:181

`Protected` before

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

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

`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:189

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

`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:156

`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:162

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

`Static` `Protected` checkMockDir

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

`Static` fetch

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

Description
Fetch static method
Inherited from Axios.fetch
- 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
Overrides Axios.getMock
- Defined in packages/@biorate/axios-prometheus/src/index.ts:77

`Static` `Protected` getMockData

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

`Static` `Protected` mockFileName

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

`Static` `Protected` mockFilePath

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

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

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

`Static` unstub

unstub(): void
Returns void

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

`Static` useMock

useMock(): void
Returns void

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

Class AxiosPrometheusAbstract

Description

Features:

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AxiosPrometheus

Properties

Private #client

Description

Abstract baseURL

Protected counter

Protected histogram

Abstract method

Abstract url

Static Protected cache

Description

Static Protected mockFields

Static Protected mocks

Type declaration

value: boolean

Description

Static Protected stubs

Type declaration

Parameters

Optional options: any

Returns Promise<AxiosResponse<any, any>>

Description

Accessors

Protected config

Returns IConfig

Static defaults

Returns AxiosDefaults<any>

Description

Methods

Protected after

Parameters

result: AxiosResponse<any, any>

startTime: [number, number]

params: IAxiosFetchOptions

Returns Promise<void>

Description

Protected before

Parameters

Optional params: IAxiosFetchOptions

Returns Promise<void>

Description

Protected catch

Parameters

e: Error | AxiosError<unknown, any>

startTime: [number, number]

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

Protected log

Parameters

statusCode: number

Class AxiosPrometheus`Abstract`

`Private` #client

`Abstract` baseURL

`Protected` counter

`Protected` histogram

`Abstract` method

`Abstract` url

`Static` `Protected` cache

`Static` `Protected` mockFields

`Static` `Protected` mocks

`Static` `Protected` stubs

`Optional` options: any

`Protected` config

`Static` defaults

`Protected` after

`Protected` before

`Optional` params: IAxiosFetchOptions

`Protected` catch

`Protected` fetch

`Optional` options: IAxiosFetchOptions

`Protected` finally

`Optional` params: IAxiosFetchOptions

`Protected` getStartTime

`Protected` log

`Static` `Protected` _fetch

`Optional` options: IAxiosFetchOptions

`Static` `Protected` checkMockDir

`Static` fetch

`Optional` options: any

`Static` `Protected` getMock

`Optional` options: IAxiosFetchOptions

`Static` `Protected` getMockData

`Static` `Protected` mockFileName

`Static` `Protected` mockFilePath

`Optional` filename: string

`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