express-service-readiness-middleware - npm Package Compare versions

Comparing version 1.0.7 to 1.0.8

dist/lib/index.d.ts

@@ -68,4 +68,8 @@ import { NextFunction, Request, Response } from "express";
 /**
+ * Returns a boolean indicating whether all critical dependencies are ready
+ */
+export declare const criticalDependenciesReady: () => Boolean;
+/**
  * Removes any NodeJS.Timeout instances created by the middleware
  */
 export declare const stopCheckingReadiness: () => void;

dist/lib/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stopCheckingReadiness = exports.setLogger = exports.checkDependenciesHealth = exports.createReadinessMiddleware = void 0;
+exports.stopCheckingReadiness = exports.criticalDependenciesReady = exports.setLogger = exports.checkDependenciesHealth = exports.createReadinessMiddleware = void 0;
 const DefaultConfig = {
@@ -81,2 +81,7 @@ retryIntervalInMilliseconds: 2000,
 /**
+ * Returns a boolean indicating whether all critical dependencies are ready
+ */
+const criticalDependenciesReady = () => ready;
+exports.criticalDependenciesReady = criticalDependenciesReady;
+/**
  * Removes any NodeJS.Timeout instances created by the middleware
@@ -83,0 +88,0 @@ */

package.json

 {
   "name": "express-service-readiness-middleware",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "This module provides express middleware for determining whether routes are exposed based on service critical dependency health.",
@@ -5,0 +5,0 @@ "repository": {

README.md

@@ -17,3 +17,4 @@
 ```bash  
-$ npm install express-service-readiness-middleware --save```  
+$ npm install express-service-readiness-middleware@1.0.8 --save
+```  
   
@@ -24,5 +25,9 @@ ## Example usage
 const {  
- checkDependenciesHealth, createReadinessMiddleware, setLogger} = require('express-service-readiness-middleware')  
+  checkDependenciesHealth, 
+  createReadinessMiddleware,
+  criticalDependenciesReady
+  setLogger
+} = require('express-service-readiness-middleware')
   
-// if s logger is not set no informational logging will occur.  Logging can be set using the 'setLogger' function.  The object must have a 'log' function.  
+// if a logger is not set no informational logging will occur.  Logging can be set using the 'setLogger' function.  The object must have a 'log' function.  
 setLogger(console)  
@@ -47,2 +52,5 @@
 */  
+
+// check whether all critical dependencies are ready
+const ready = criticalDependenciesReady()
 ```  
@@ -83,4 +91,20 @@
 const health = await checkDependenciesHealth(dependencies)  
-```  
+```
 
+## criticalDependenciesReady
+
+Boolean function that can be called to determine whether all critical dependencies are ready.
+
+```js  
+const ready = criticalDependenciesReady()
+```
+
+## stopCheckingReadiness
+
+Stops checking whether service dependencies are ready
+
+```js  
+stopCheckingReadiness()
+```
+
 ## License
@@ -87,0 +111,0 @@

No alert changes

Improved metrics

Total package byte prevSize

20120

increased by4.64%

Lines of code

235

increased by3.98%

Number of lines in readme file

128

increased by23.08%

No dependency changes