MetricState
Constructors
Signature
declare const counter: {
(count: number): Counter<number>;
(count: bigint): Counter<bigint>;
};Signature
declare const frequency: (occurrences: ReadonlyMap<string, number>) => MetricState.Frequency;Signature
declare const gauge: {
(count: number): Gauge<number>;
(count: bigint): Gauge<bigint>;
};Signature
declare const histogram: (options: {
readonly buckets: ReadonlyArray<readonly [number, number]>;
readonly count: number;
readonly max: number;
readonly min: number;
readonly sum: number;
}) => MetricState.Histogram;Signature
declare const summary: (options: {
readonly count: number;
readonly error: number;
readonly max: number;
readonly min: number;
readonly quantiles: ReadonlyArray<readonly [number, Option.Option<number>]>;
readonly sum: number;
}) => MetricState.Summary;Models
MetricState interface
Added in v2.0.0
Source
Signature
interface MetricState<in A> extends Variance<A>, Equal, Pipeable {}Other
MetricState
Added in v2.0.0
Source
Refinements
isCounterState
Added in v2.0.0
Source
Signature
declare const isCounterState: (u: unknown) => u is MetricState.Counter<number | bigint>;isFrequencyState
Added in v2.0.0
Source
Signature
declare const isFrequencyState: (u: unknown) => u is MetricState.Frequency;isGaugeState
Added in v2.0.0
Source
Signature
declare const isGaugeState: (u: unknown) => u is MetricState.Gauge<number | bigint>;isHistogramState
Added in v2.0.0
Source
Signature
declare const isHistogramState: (u: unknown) => u is MetricState.Histogram;isMetricState
Added in v2.0.0
Source
Signature
declare const isMetricState: (u: unknown) => u is MetricState.Counter<number | bigint>;isSummaryState
Added in v2.0.0
Source
Signature
declare const isSummaryState: (u: unknown) => u is MetricState.Summary;Symbols
CounterStateTypeId
Added in v2.0.0
Source
Signature
declare const CounterStateTypeId: unique symbol;CounterStateTypeId type
Added in v2.0.0
Source
Signature
type CounterStateTypeId = typeof CounterStateTypeId;FrequencyStateTypeId
Added in v2.0.0
Source
Signature
declare const FrequencyStateTypeId: unique symbol;FrequencyStateTypeId type
Added in v2.0.0
Source
Signature
type FrequencyStateTypeId = typeof FrequencyStateTypeId;GaugeStateTypeId
Added in v2.0.0
Source
Signature
declare const GaugeStateTypeId: unique symbol;GaugeStateTypeId type
Added in v2.0.0
Source
Signature
type GaugeStateTypeId = typeof GaugeStateTypeId;HistogramStateTypeId
Added in v2.0.0
Source
Signature
declare const HistogramStateTypeId: unique symbol;HistogramStateTypeId type
Added in v2.0.0
Source
Signature
type HistogramStateTypeId = typeof HistogramStateTypeId;MetricStateTypeId
Added in v2.0.0
Source
Signature
declare const MetricStateTypeId: unique symbol;MetricStateTypeId type
Added in v2.0.0
Source
Signature
type MetricStateTypeId = typeof MetricStateTypeId;SummaryStateTypeId
Added in v2.0.0
Source
Signature
declare const SummaryStateTypeId: unique symbol;SummaryStateTypeId type
Added in v2.0.0
Source
Signature
type SummaryStateTypeId = typeof SummaryStateTypeId;
A
MetricStatedescribes the state of a metric. The type parameter of a metric state corresponds to the type of the metric key (MetricStateType). This phantom type parameter is used to tie keys to their expected states.