MetricLabel.ts overview

Since v2.0.0

Exports Grouped by Category

• constructors
  • make
• models
  • MetricLabel (interface)
• refinements
  • isMetricLabel
• symbols
  • MetricLabelTypeId
  • MetricLabelTypeId (type alias)

constructors

make

Signature

declare const make: (key: string, value: string) => MetricLabel

Source

Since v2.0.0

models

MetricLabel (interface)

A MetricLabel represents a key value pair that allows analyzing metrics at an additional level of granularity.

For example if a metric tracks the response time of a service labels could be used to create separate versions that track response times for different clients.

Signature

export interface MetricLabel extends Equal.Equal, Pipeable {
  readonly [MetricLabelTypeId]: MetricLabelTypeId
  readonly key: string
  readonly value: string
}

Source

Since v2.0.0

refinements

isMetricLabel

Signature

declare const isMetricLabel: (u: unknown) => u is MetricLabel

Source

Since v2.0.0

symbols

MetricLabelTypeId

Signature

declare const MetricLabelTypeId: unique symbol

Source

Since v2.0.0

MetricLabelTypeId (type alias)

Signature

type MetricLabelTypeId = typeof MetricLabelTypeId

Source

Since v2.0.0