Skip to main content Link Search Menu Expand Document (external link)

MetricRegistry.ts overview

Since v2.0.0


Exports Grouped by Category


constructors

make

Signature

declare const make: (_: void) => MetricRegistry

Source

Since v2.0.0

models

MetricRegistry (interface)

Signature

export interface MetricRegistry {
  readonly [MetricRegistryTypeId]: MetricRegistryTypeId
  snapshot(): Array<MetricPair.MetricPair.Untyped>
  get<Type extends MetricKeyType.MetricKeyType<any, any>>(
    key: MetricKey.MetricKey<Type>
  ): MetricHook.MetricHook<
    MetricKeyType.MetricKeyType.InType<(typeof key)["keyType"]>,
    MetricKeyType.MetricKeyType.OutType<(typeof key)["keyType"]>
  >
  getCounter<A extends number | bigint>(key: MetricKey.MetricKey.Counter<A>): MetricHook.MetricHook.Counter<A>
  getFrequency(key: MetricKey.MetricKey.Frequency): MetricHook.MetricHook.Frequency
  getGauge<A extends number | bigint>(key: MetricKey.MetricKey.Gauge<A>): MetricHook.MetricHook.Gauge<A>
  getHistogram(key: MetricKey.MetricKey.Histogram): MetricHook.MetricHook.Histogram
  getSummary(key: MetricKey.MetricKey.Summary): MetricHook.MetricHook.Summary
}

Source

Since v2.0.0

symbols

MetricRegistryTypeId

Signature

declare const MetricRegistryTypeId: unique symbol

Source

Since v2.0.0

MetricRegistryTypeId (type alias)

Signature

type MetricRegistryTypeId = typeof MetricRegistryTypeId

Source

Since v2.0.0