@tahminator/sapling 2.1.0-beta.39c06f1e → 2.1.0-beta.4344e0ca

package/dist/index.cjs

@@ -409,7 +409,7 @@ let HealthRegistrar = class HealthRegistrar {
 	/**
 	* Add a health check.
 	*
-	* Health checks will be used to determine whether service can service traffic or not (a.k.a `liveness`).
+	* Health checks will be used to determine whether service can serve traffic or not (a.k.a `liveness`).
 	*/
 	add(healthCheck) {
 		this._checks.push(healthCheck);
@@ -421,7 +421,16 @@ let HealthRegistrar = class HealthRegistrar {
 	_markReady() {
 		this._ready = true;
 	}
-	async check() {
+	/**
+	* @internal
+	*/
+	async ready() {
+		return this._ready;
+	}
+	/**
+	* @internal
+	*/
+	async live() {
 		if (!this._ready) return false;
 		return (await Promise.all(this._checks.map((c) => c()))).every((c) => c === true);
 	}
@@ -516,7 +525,7 @@ var Sapling = class Sapling {
 				return function(...args) {
 					const server = originalListen.apply(target, args);
 					server.once("listening", () => {
-						Sapling.onPostStartup();
+						Sapling._onPostStartup();
 						console.log("Sapling successfully initialized post-startup hooks on server start");
 					});
 					return server;
@@ -525,7 +534,11 @@ var Sapling = class Sapling {
 			return Reflect.get(target, prop, receiver);
 		} });
 	}
-	static onPostStartup() {
+	/**
+	* @internal
+	* visible for testing
+	*/
+	static _onPostStartup() {
 		_InjectableRegistry.get(HealthRegistrar)?._markReady();
 	}
 	/**
@@ -1213,11 +1226,11 @@ let DefaultHealthMiddleware = class DefaultHealthMiddleware {
 		this.healthRegistrar = healthRegistrar;
 	}
 	async readiness(_request, _response, _next) {
-		const up = await this.healthRegistrar.check();
+		const up = await this.healthRegistrar.ready();
 		return ResponseEntity.ok().body({ up });
 	}
 	async liveness(_request, _response, _next) {
-		const up = await this.healthRegistrar.check();
+		const up = await this.healthRegistrar.live();
 		return ResponseEntity.ok().body({ up });
 	}
 };

package/dist/index.d.cts

@@ -853,7 +853,11 @@ declare class Sapling {
    * ```
    */
   static registerApp(app: e.Express): e.Express;
-  static onPostStartup(): void;
+  /**
+   * @internal
+   * visible for testing
+   */
+  static _onPostStartup(): void;
   /**
    * Serialize a value into a JSON string.
    *
@@ -1123,7 +1127,7 @@ declare class HealthRegistrar {
   /**
    * Add a health check.
    *
-   * Health checks will be used to determine whether service can service traffic or not (a.k.a `liveness`).
+   * Health checks will be used to determine whether service can serve traffic or not (a.k.a `liveness`).
    */
   add(healthCheck: HealthCheck): void;
   /**
@@ -1131,7 +1135,14 @@ declare class HealthRegistrar {
    * checks have been registered and server is, at the very least, alive.
    */
   _markReady(): void;
-  check(): Promise<boolean>;
+  /**
+   * @internal
+   */
+  ready(): Promise<boolean>;
+  /**
+   * @internal
+   */
+  live(): Promise<boolean>;
 }
 //#endregion
 //#region src/middleware/default/health/index.d.ts

package/dist/index.d.mts

@@ -853,7 +853,11 @@ declare class Sapling {
    * ```
    */
   static registerApp(app: e.Express): e.Express;
-  static onPostStartup(): void;
+  /**
+   * @internal
+   * visible for testing
+   */
+  static _onPostStartup(): void;
   /**
    * Serialize a value into a JSON string.
    *
@@ -1123,7 +1127,7 @@ declare class HealthRegistrar {
   /**
    * Add a health check.
    *
-   * Health checks will be used to determine whether service can service traffic or not (a.k.a `liveness`).
+   * Health checks will be used to determine whether service can serve traffic or not (a.k.a `liveness`).
    */
   add(healthCheck: HealthCheck): void;
   /**
@@ -1131,7 +1135,14 @@ declare class HealthRegistrar {
    * checks have been registered and server is, at the very least, alive.
    */
   _markReady(): void;
-  check(): Promise<boolean>;
+  /**
+   * @internal
+   */
+  ready(): Promise<boolean>;
+  /**
+   * @internal
+   */
+  live(): Promise<boolean>;
 }
 //#endregion
 //#region src/middleware/default/health/index.d.ts

package/dist/index.mjs

@@ -384,7 +384,7 @@ let HealthRegistrar = class HealthRegistrar {
 	/**
 	* Add a health check.
 	*
-	* Health checks will be used to determine whether service can service traffic or not (a.k.a `liveness`).
+	* Health checks will be used to determine whether service can serve traffic or not (a.k.a `liveness`).
 	*/
 	add(healthCheck) {
 		this._checks.push(healthCheck);
@@ -396,7 +396,16 @@ let HealthRegistrar = class HealthRegistrar {
 	_markReady() {
 		this._ready = true;
 	}
-	async check() {
+	/**
+	* @internal
+	*/
+	async ready() {
+		return this._ready;
+	}
+	/**
+	* @internal
+	*/
+	async live() {
 		if (!this._ready) return false;
 		return (await Promise.all(this._checks.map((c) => c()))).every((c) => c === true);
 	}
@@ -491,7 +500,7 @@ var Sapling = class Sapling {
 				return function(...args) {
 					const server = originalListen.apply(target, args);
 					server.once("listening", () => {
-						Sapling.onPostStartup();
+						Sapling._onPostStartup();
 						console.log("Sapling successfully initialized post-startup hooks on server start");
 					});
 					return server;
@@ -500,7 +509,11 @@ var Sapling = class Sapling {
 			return Reflect.get(target, prop, receiver);
 		} });
 	}
-	static onPostStartup() {
+	/**
+	* @internal
+	* visible for testing
+	*/
+	static _onPostStartup() {
 		_InjectableRegistry.get(HealthRegistrar)?._markReady();
 	}
 	/**
@@ -1188,11 +1201,11 @@ let DefaultHealthMiddleware = class DefaultHealthMiddleware {
 		this.healthRegistrar = healthRegistrar;
 	}
 	async readiness(_request, _response, _next) {
-		const up = await this.healthRegistrar.check();
+		const up = await this.healthRegistrar.ready();
 		return ResponseEntity.ok().body({ up });
 	}
 	async liveness(_request, _response, _next) {
-		const up = await this.healthRegistrar.check();
+		const up = await this.healthRegistrar.live();
 		return ResponseEntity.ok().body({ up });
 	}
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tahminator/sapling",
-  "version": "2.1.0-beta.39c06f1e",
+  "version": "2.1.0-beta.4344e0ca",
   "author": "Tahmid Ahmed",
   "description": "A library to help you write cleaner Express.js code",
   "repository": {