🤖 Merge PR DefinitelyTyped#72901 feat: ✨ add types for opossum-prometheus by @iamchathu

Author: iamchathu

types/opossum-prometheus/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/opossum-prometheus/index.d.ts

@@ -0,0 +1,49 @@
+import type * as CircuitBreaker from "opossum";
+import type { Registry } from "prom-client";
+
+/**
+ * Options for configuring OpossumMetrics.
+ */
+interface OpossumMetricsOptions {
+    /**
+     * A list or individual circuit breaker to create metrics for.
+     * @default undefined - No circuits.
+     */
+    circuits?: CircuitBreaker[] | undefined;
+
+    /**
+     * An existing registry to use for prometheus metrics.
+     * @default undefined  - The default prometheus registry will be used and default system metrics will be collected
+     */
+    registry?: Registry | undefined;
+
+    /**
+     * Measure the performance of breakers and report them through the registry.
+     * @default true
+     */
+    exposePerformanceMetrics?: boolean | undefined;
+
+    /**
+     * Prefix for circuit breakers metrics name.
+     */
+    metricPrefix?: string | undefined;
+}
+
+/**
+ * Class for integrating Opossum circuit breakers with Prometheus metrics.
+ */
+declare class OpossumMetrics {
+    /**
+     * Creates an instance of OpossumMetrics.
+     * @param options - Configuration options for the metrics.
+     */
+    constructor(options?: OpossumMetricsOptions);
+
+    /**
+     * Adds a circuit breaker to be monitored.
+     * @param circuit - The circuit breaker to add.
+     */
+    add(circuit: CircuitBreaker): void;
+}
+
+export = OpossumMetrics;

types/opossum-prometheus/opossum-prometheus-tests.ts

@@ -0,0 +1,14 @@
+import type * as CircuitBreaker from "opossum";
+import OpossumMetrics from "opossum-prometheus";
+import type { Registry } from "prom-client";
+
+// $ExpectType OpossumMetrics
+const opossumPrometheus: OpossumMetrics = new OpossumMetrics({
+    circuits: [{} as CircuitBreaker],
+    registry: {} as Registry,
+    exposePerformanceMetrics: true,
+    metricPrefix: "my_prefix_",
+});
+
+// $ExpectType void
+opossumPrometheus.add({} as CircuitBreaker);

types/opossum-prometheus/package.json

@@ -0,0 +1,22 @@
+{
+    "private": true,
+    "name": "@types/opossum-prometheus",
+    "version": "0.4.9999",
+    "projects": [
+        "https://github.com/nodeshift/opossum-prometheus#readme"
+    ],
+    "dependencies": {
+        "@types/node": "*",
+        "@types/opossum": "*",
+        "prom-client": "*"
+    },
+    "devDependencies": {
+        "@types/opossum-prometheus": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Chathu Vishwaijith",
+            "githubUsername": "iamchathu"
+        }
+    ]
+}

types/opossum-prometheus/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "opossum-prometheus-tests.ts"
+    ]
+}