MetricState.ts overview
Since v2.0.0
Exports Grouped by Category
- constructors
- models
- refinements
- symbols
- CounterStateTypeId
- CounterStateTypeId (type alias)
- FrequencyStateTypeId
- FrequencyStateTypeId (type alias)
- GaugeStateTypeId
- GaugeStateTypeId (type alias)
- HistogramStateTypeId
- HistogramStateTypeId (type alias)
- MetricStateTypeId
- MetricStateTypeId (type alias)
- SummaryStateTypeId
- SummaryStateTypeId (type alias)
- utils
constructors
counter
Signature
declare const counter: { (count: number): MetricState.Counter<number>; (count: bigint): MetricState.Counter<bigint> }
Since v2.0.0
frequency
Signature
declare const frequency: (occurrences: ReadonlyMap<string, number>) => MetricState.Frequency
Since v2.0.0
gauge
Signature
declare const gauge: { (count: number): MetricState.Gauge<number>; (count: bigint): MetricState.Gauge<bigint> }
Since v2.0.0
histogram
Signature
declare const histogram: (options: {
readonly buckets: ReadonlyArray<readonly [number, number]>
readonly count: number
readonly min: number
readonly max: number
readonly sum: number
}) => MetricState.Histogram
Since v2.0.0
summary
Signature
declare const summary: (options: {
readonly error: number
readonly quantiles: ReadonlyArray<readonly [number, Option.Option<number>]>
readonly count: number
readonly min: number
readonly max: number
readonly sum: number
}) => MetricState.Summary
Since v2.0.0
models
MetricState (interface)
A MetricState
describes 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.
Signature
export interface MetricState<in A> extends MetricState.Variance<A>, Equal.Equal, Pipeable {}
Since v2.0.0
refinements
isCounterState
Signature
declare const isCounterState: (u: unknown) => u is MetricState.Counter<number | bigint>
Since v2.0.0
isFrequencyState
Signature
declare const isFrequencyState: (u: unknown) => u is MetricState.Frequency
Since v2.0.0
isGaugeState
Signature
declare const isGaugeState: (u: unknown) => u is MetricState.Gauge<number | bigint>
Since v2.0.0
isHistogramState
Signature
declare const isHistogramState: (u: unknown) => u is MetricState.Histogram
Since v2.0.0
isMetricState
Signature
declare const isMetricState: (u: unknown) => u is MetricState.Counter<number | bigint>
Since v2.0.0
isSummaryState
Signature
declare const isSummaryState: (u: unknown) => u is MetricState.Summary
Since v2.0.0
symbols
CounterStateTypeId
Signature
declare const CounterStateTypeId: unique symbol
Since v2.0.0
CounterStateTypeId (type alias)
Signature
type CounterStateTypeId = typeof CounterStateTypeId
Since v2.0.0
FrequencyStateTypeId
Signature
declare const FrequencyStateTypeId: unique symbol
Since v2.0.0
FrequencyStateTypeId (type alias)
Signature
type FrequencyStateTypeId = typeof FrequencyStateTypeId
Since v2.0.0
GaugeStateTypeId
Signature
declare const GaugeStateTypeId: unique symbol
Since v2.0.0
GaugeStateTypeId (type alias)
Signature
type GaugeStateTypeId = typeof GaugeStateTypeId
Since v2.0.0
HistogramStateTypeId
Signature
declare const HistogramStateTypeId: unique symbol
Since v2.0.0
HistogramStateTypeId (type alias)
Signature
type HistogramStateTypeId = typeof HistogramStateTypeId
Since v2.0.0
MetricStateTypeId
Signature
declare const MetricStateTypeId: unique symbol
Since v2.0.0
MetricStateTypeId (type alias)
Signature
type MetricStateTypeId = typeof MetricStateTypeId
Since v2.0.0
SummaryStateTypeId
Signature
declare const SummaryStateTypeId: unique symbol
Since v2.0.0
SummaryStateTypeId (type alias)
Signature
type SummaryStateTypeId = typeof SummaryStateTypeId
Since v2.0.0
utils
MetricState (namespace)
Since v2.0.0
Untyped (interface)
Signature
export interface Untyped extends MetricState<any> {}
Since v2.0.0
Counter (interface)
Signature
export interface Counter<in out A extends number | bigint> extends MetricState<MetricKeyType.MetricKeyType.Counter<A>> {
readonly [CounterStateTypeId]: CounterStateTypeId
readonly count: A
}
Since v2.0.0
Frequency (interface)
Signature
export interface Frequency extends MetricState<MetricKeyType.MetricKeyType.Frequency> {
readonly [FrequencyStateTypeId]: FrequencyStateTypeId
readonly occurrences: ReadonlyMap<string, number>
}
Since v2.0.0
Gauge (interface)
Signature
export interface Gauge<in out A extends number | bigint> extends MetricState<MetricKeyType.MetricKeyType.Gauge<A>> {
readonly [GaugeStateTypeId]: GaugeStateTypeId
readonly value: A
}
Since v2.0.0
Histogram (interface)
Signature
export interface Histogram extends MetricState<MetricKeyType.MetricKeyType.Histogram> {
readonly [HistogramStateTypeId]: HistogramStateTypeId
readonly buckets: ReadonlyArray<readonly [number, number]>
readonly count: number
readonly min: number
readonly max: number
readonly sum: number
}
Since v2.0.0
Summary (interface)
Signature
export interface Summary extends MetricState<MetricKeyType.MetricKeyType.Summary> {
readonly [SummaryStateTypeId]: SummaryStateTypeId
readonly error: number
readonly quantiles: ReadonlyArray<readonly [number, Option.Option<number>]>
readonly count: number
readonly min: number
readonly max: number
readonly sum: number
}
Since v2.0.0
Variance (interface)
Signature
export interface Variance<in A> {
readonly [MetricStateTypeId]: {
readonly _A: Types.Contravariant<A>
}
}
Since v2.0.0