Add healthcheck API

mrzen · Sep 18, 2024 · 43ee70f · 43ee70f
1 parent dc152b8
commit 43ee70f
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "tigerbay",
-  "version": "1.1.0-beta.7",
+  "version": "1.1.1-beta.1",
   "description": "API Client library for TigerBay",
   "main": "lib/client.js",
   "type": "commonjs",

diff --git a/src/client.ts b/src/client.ts
@@ -106,6 +106,11 @@ export class Client {
         return new NoteManager(this.axios)
     }
 
+
+    public async healthcheck(): Promise<HealthCheckResponse> {
+        return (await this.axios.get('/healthcheck')).data
+    }
+
     /**
      * Add a new interceptor before a request is sent
      * 
@@ -173,3 +178,11 @@ export interface ClientConfig {
     credentials: Auth.CredentialsProvider
 }
 
+export interface HealthCheckResponse {
+    [key: string]: {
+        Name: string
+        IsHealthy: boolean
+        Message: string
+        Duration: string
+    }    
+}