@ralphschuler.prom metrics decorator.<internal>

Module: <internal>

Table of contents

Namespaces

• Counter
• Gauge
• Histogram
• Summary

Enumerations

• MetricType

Classes

• Counter
• Gauge
• Histogram
• Registry
• Summary

Interfaces

• CounterConfiguration
• GaugeConfiguration
• HistogramConfiguration
• MetricConfiguration
• MetricObject
• MetricObjectWithValues
• Object
• PropertyDescriptor
• SummaryConfiguration

Type Aliases

• Aggregator
• CollectFunction
• LabelValues
• Metric
• MetricValue
• MetricValueWithName
• Partial
• PropertyKey
• Record

Functions

• Object

Type Aliases

Aggregator

Ƭ Aggregator: "omit" | "sum" | "first" | "min" | "max" | "average"

Aggregation methods, used for aggregating metrics in a Node.js cluster.

Defined in

node_modules/prom-client/index.d.ts:128

---

CollectFunction

Ƭ CollectFunction<T>: (this: T) => void | Promise<void>

Type parameters

Name
T

Type declaration

▸ (this): void | Promise<void>

Parameters

Name	Type
this	T

Returns

void | Promise<void>

Defined in

node_modules/prom-client/index.d.ts:137

---

LabelValues

Ƭ LabelValues<T>: Partial<Record<T, string | number>>

Type parameters

Name	Type
T	extends string

Defined in

node_modules/prom-client/index.d.ts:161

---

Metric

Ƭ Metric<T>: Counter<T> | Gauge<T> | Summary<T> | Histogram<T>

General metric type

Type parameters

Name	Type
T	extends string = string

Defined in

node_modules/prom-client/index.d.ts:119

---

MetricValue

Ƭ MetricValue<T>: Object

Type parameters

Name	Type
T	extends string

Type declaration

Name	Type
labels	LabelValues<T>
value	number

Defined in

node_modules/prom-client/index.d.ts:152

---

MetricValueWithName

Ƭ MetricValueWithName<T>: MetricValue<T> & { metricName?: string }

Type parameters

Name	Type
T	extends string

Defined in

node_modules/prom-client/index.d.ts:157

---

Partial

Ƭ Partial<T>: { [P in keyof T]?: T[P] }

Make all properties in T optional

Type parameters

Name
T

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1577

---

PropertyKey

Ƭ PropertyKey: string | number | symbol

Defined in

node_modules/typescript/lib/lib.es5.d.ts:108

---

Record

Ƭ Record<K, T>: { [P in K]: T }

Construct a type with a set of properties K of type T

Type parameters

Name	Type
K	extends keyof any
T	T

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1605

Functions

Object

▸ Object(): any

Provides functionality common to all JavaScript objects.

Returns

any

Defined in

node_modules/typescript/lib/lib.es5.d.ts:157

▸ Object(value): any

Provides functionality common to all JavaScript objects.

Parameters

Name	Type
value	any

Returns

any

Defined in

node_modules/typescript/lib/lib.es5.d.ts:158