From 5b9c3a8c0591480b15502df9b733206b884e31e6 Mon Sep 17 00:00:00 2001
From: "Dominik.Sigmund" <dominik.sigmund@br.de>
Date: Thu, 21 Mar 2024 09:51:59 +0100
Subject: [PATCH] Added types
---
README.md | 2 +-
index.d.ts | 27 +++++++++++++++++++++++++++
package.json | 2 +-
3 files changed, 29 insertions(+), 2 deletions(-)
create mode 100644 index.d.ts
diff --git a/README.md b/README.md
index 5052c86..4a16102 100755
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ Add default metaroutes to express app
## Usage
-`const metaRoutes = require('@libs/metaroutes');`
+`const metaRoutes = require('@libs/metaroutes');` or `import metaRoutes from './metaRoutes';`
`metaRoutes(app, { version, config, isServiceReady, metricsEndpoint }, routeOptions);`
Where:
diff --git a/index.d.ts b/index.d.ts
new file mode 100644
index 0000000..8773a05
--- /dev/null
+++ b/index.d.ts
@@ -0,0 +1,27 @@
+// Import express types for app and RequestHandler
+import { Express, RequestHandler } from 'express';
+
+interface MetaRoutesOptions {
+ enableVersion?: boolean;
+ enableConfig?: boolean;
+ enableHealth?: boolean;
+ enableReady?: boolean;
+ enableMetrics?: boolean;
+}
+
+interface Config {
+ _show: () => object; // Adjust according to the actual method signature
+}
+
+interface MetaRouteDependencies {
+ version: string;
+ config: Config;
+ isServiceReady: () => boolean;
+ metricsEndpoint: RequestHandler;
+}
+
+// Declaration of the metaRoutes function
+declare function metaRoutes(app: Express, dependencies: MetaRouteDependencies, routeOptions?: MetaRoutesOptions): void;
+
+// Export the metaRoutes function to match your JS export
+export = metaRoutes;
\ No newline at end of file
diff --git a/package.json b/package.json
index 372aebd..3b443f3 100755
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@libs/metaroutes",
- "version": "1.1.0",
+ "version": "1.2.0",
"description": "Add default metaroutes to express app",
"main": "index.js",
"scripts": {
--
GitLab