Skip to content
Effect Days 2026 Get your ticket

MetricKeyType

25 exports Added in v2.0.0 Source

Constructors

counter

Added in v2.0.0 Source

Signature

declare const counter: <A extends number | bigint>() => MetricKeyType.Counter<A>

frequency

Added in v2.0.0 Source

Signature

declare const frequency: (options?: {
readonly preregisteredWords?: ReadonlyArray<string>;
}) => MetricKeyType.Frequency

gauge

Added in v2.0.0 Source

Signature

declare const gauge: <A extends number | bigint>() => MetricKeyType.Gauge<A>

histogram

Added in v2.0.0 Source

Signature

declare const histogram: (boundaries: MetricBoundaries.MetricBoundaries) => MetricKeyType.Histogram

summary

Added in v2.0.0 Source

Signature

declare const summary: (options: {
readonly error: number;
readonly maxAge: Duration.DurationInput;
readonly maxSize: number;
readonly quantiles: ReadonlyArray<number>;
}) => MetricKeyType.Summary

Modelz

MetricKeyType interface

Added in v2.0.0 Source

Signature

interface MetricKeyType<in In, out Out> extends Variance<In, Out>, Equal, Pipeable {}

Other

Refinements

isCounterKey

Added in v2.0.0 Source

Signature

declare const isCounterKey: (u: unknown) => u is MetricKeyType.Counter<number | bigint>

Signature

declare const isFrequencyKey: (u: unknown) => u is MetricKeyType.Frequency

isGaugeKey

Added in v2.0.0 Source

Signature

declare const isGaugeKey: (u: unknown) => u is MetricKeyType.Gauge<number | bigint>

Signature

declare const isHistogramKey: (u: unknown) => u is MetricKeyType.Histogram

Signature

declare const isMetricKeyType: (u: unknown) => u is MetricKeyType<unknown, unknown>

isSummaryKey

Added in v2.0.0 Source

Signature

declare const isSummaryKey: (u: unknown) => u is MetricKeyType.Summary

Symbols

Signature

declare const CounterKeyTypeTypeId: unique symbol

CounterKeyTypeTypeId type

Added in v2.0.0 Source

Signature

type CounterKeyTypeTypeId = typeof CounterKeyTypeTypeId

Signature

declare const FrequencyKeyTypeTypeId: unique symbol

Signature

type FrequencyKeyTypeTypeId = typeof FrequencyKeyTypeTypeId

Signature

declare const GaugeKeyTypeTypeId: unique symbol

GaugeKeyTypeTypeId type

Added in v2.0.0 Source

Signature

type GaugeKeyTypeTypeId = typeof GaugeKeyTypeTypeId

Signature

declare const HistogramKeyTypeTypeId: unique symbol

Signature

type HistogramKeyTypeTypeId = typeof HistogramKeyTypeTypeId

Signature

declare const MetricKeyTypeTypeId: unique symbol

MetricKeyTypeTypeId type

Added in v2.0.0 Source

Signature

type MetricKeyTypeTypeId = typeof MetricKeyTypeTypeId

Signature

declare const SummaryKeyTypeTypeId: unique symbol

SummaryKeyTypeTypeId type

Added in v2.0.0 Source

Signature

type SummaryKeyTypeTypeId = typeof SummaryKeyTypeTypeId