mirror of https://github.com/ghostfolio/ghostfolio
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
47 lines
1.1 KiB
47 lines
1.1 KiB
/**
|
|
* @since 2.0.0
|
|
*/
|
|
import type * as Equal from "./Equal.js"
|
|
import * as internal from "./internal/metric/label.js"
|
|
import type { Pipeable } from "./Pipeable.js"
|
|
|
|
/**
|
|
* @since 2.0.0
|
|
* @category symbols
|
|
*/
|
|
export const MetricLabelTypeId: unique symbol = internal.MetricLabelTypeId
|
|
|
|
/**
|
|
* @since 2.0.0
|
|
* @category symbols
|
|
*/
|
|
export type MetricLabelTypeId = typeof MetricLabelTypeId
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @since 2.0.0
|
|
* @category models
|
|
*/
|
|
export interface MetricLabel extends Equal.Equal, Pipeable {
|
|
readonly [MetricLabelTypeId]: MetricLabelTypeId
|
|
readonly key: string
|
|
readonly value: string
|
|
}
|
|
|
|
/**
|
|
* @since 2.0.0
|
|
* @category constructors
|
|
*/
|
|
export const make: (key: string, value: string) => MetricLabel = internal.make
|
|
|
|
/**
|
|
* @since 2.0.0
|
|
* @category refinements
|
|
*/
|
|
export const isMetricLabel: (u: unknown) => u is MetricLabel = internal.isMetricLabel
|
|
|