From 941e906d217c99feb9e076b4b1222b527fbf35b1 Mon Sep 17 00:00:00 2001
From: nflaig <nflaig@protonmail.com>
Date: Tue, 17 Jan 2023 13:06:37 +0100
Subject: [PATCH] fix: add get method to type definitions of metric classes

---
 CHANGELOG.md |  2 ++
 index.d.ts   | 40 +++++++++++++++++++++++++++++++++++++---
 2 files changed, 39 insertions(+), 3 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 57da02ac..8f469b90 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -15,6 +15,8 @@ project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+- Add `get` method to type definitions of metric classes
+
 ## [14.1.1] - 2022-12-31
 
 ### Changed
diff --git a/index.d.ts b/index.d.ts
index a99bcd0c..e0435578 100644
--- a/index.d.ts
+++ b/index.d.ts
@@ -29,12 +29,12 @@ export class Registry {
 	/**
 	 * Get all metrics as objects
 	 */
-	getMetricsAsJSON(): Promise<metric[]>;
+	getMetricsAsJSON(): Promise<MetricObjectWithValues<MetricValue<string>>[]>;
 
 	/**
 	 * Get all metrics as objects
 	 */
-	getMetricsAsArray(): metric[];
+	getMetricsAsArray(): MetricObject[];
 
 	/**
 	 * Remove a single metric
@@ -136,7 +136,7 @@ export enum MetricType {
 
 type CollectFunction<T> = (this: T) => void | Promise<void>;
 
-interface metric {
+interface MetricObject {
 	name: string;
 	help: string;
 	type: MetricType;
@@ -144,6 +144,20 @@ interface metric {
 	collect: CollectFunction<any>;
 }
 
+interface MetricObjectWithValues<T extends MetricValue<string>>
+	extends MetricObject {
+	values: T[];
+}
+
+type MetricValue<T extends string> = {
+	value: number;
+	labels: LabelValues<T>;
+};
+
+type MetricValueWithName<T extends string> = MetricValue<T> & {
+	metricName?: string;
+};
+
 type LabelValues<T extends string> = Partial<Record<T, string | number>>;
 
 interface MetricConfiguration<T extends string> {
@@ -182,6 +196,11 @@ export class Counter<T extends string = string> {
 	 */
 	inc(value?: number): void;
 
+	/**
+	 * Get counter metric object
+	 */
+	get(): Promise<MetricObjectWithValues<MetricValue<T>>>;
+
 	/**
 	 * Return the child for given labels
 	 * @param values Label values
@@ -277,6 +296,11 @@ export class Gauge<T extends string = string> {
 	 */
 	set(value: number): void;
 
+	/**
+	 * Get gauge metric object
+	 */
+	get(): Promise<MetricObjectWithValues<MetricValue<T>>>;
+
 	/**
 	 * Set gauge value to current epoch time in ms
 	 * @param labels Object with label keys and values
@@ -386,6 +410,11 @@ export class Histogram<T extends string = string> {
 	 */
 	observe(labels: LabelValues<T>, value: number): void;
 
+	/**
+	 * Get histogram metric object
+	 */
+	get(): Promise<MetricObjectWithValues<MetricValueWithName<T>>>;
+
 	/**
 	 * Start a timer. Calling the returned function will observe the duration in
 	 * seconds in the histogram.
@@ -488,6 +517,11 @@ export class Summary<T extends string = string> {
 	 */
 	observe(labels: LabelValues<T>, value: number): void;
 
+	/**
+	 * Get summary metric object
+	 */
+	get(): Promise<MetricObjectWithValues<MetricValueWithName<T>>>;
+
 	/**
 	 * Start a timer. Calling the returned function will observe the duration in
 	 * seconds in the summary.