Class AxiosPrometheusAbstract

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)

Constructors

constructor

Properties

#private baseURL counter method timeout url #histogram cache mockFields mocks

Accessors

config histogram defaults options stubs

Methods

after before catch fetch finally fullUrl getStartTime log needTrace stringify _fetch checkMockDir fetch getMock getMockData instance mockFileName mockFilePath setMock stub unstub useMock

Constructors

Protected constructor

Properties

Private #private

#private: any

Abstract baseURL

baseURL: string

Protected counter

counter: Counter<string>

Abstract method

method: string

timeout

timeout: number

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

Accessors

Protected config

Protected histogram

Static defaults

  • get defaults(): Omit<AxiosDefaults<any>, "headers"> & {
        headers: HeadersDefaults & {
            [key: string]: AxiosHeaderValue;
        };
    }

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

Static options

  • get options(): Options

  • Returns Options

Static Protected stubs

  • get stubs(): Stubs

  • Returns Stubs

Methods

Protected after

Protected before

Protected catch

Protected fetch

Protected finally

  • finally(startTime, params?): Promise<void>

  • Parameters

    Returns Promise<void>

Protected fullUrl

Protected getStartTime

Protected log

Protected needTrace

Protected stringify

Static Protected _fetch

Static Protected checkMockDir

Static fetch

  • fetch(options?): Promise<AxiosResponse<any, any, {}>>

  • Parameters

    • Optional options: any

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

Static Protected getMock

Static Protected getMockData

Static Protected instance

  • instance<T>(): T

  • Type Parameters

    • T

    Returns T

Static Protected mockFileName

Static Protected mockFilePath

Static Protected setMock

Static stub

  • stub(params, persist?): void

  • Parameters

    Returns void

Static unstub

  • unstub(): void

  • Returns void

Static useMock

  • useMock(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

constructor#privatebaseURLcountermethodtimeouturl#histogramcachemockFieldsmocksconfighistogramdefaultsoptionsstubsafterbeforecatchfetchfinallyfullUrlgetStartTimelogneedTracestringify_fetchcheckMockDirfetchgetMockgetMockDatainstancemockFileNamemockFilePathsetMockstubunstubuseMock