@tahminator/sapling 2.1.0-beta.a2de2fb9 → 2.1.0-beta.bcb66b15

package/dist/index.cjs

@@ -401,22 +401,23 @@ function __decorate(decorators, target, key, desc) {
 //#region src/middleware/health/registrar.ts
 let HealthRegistrar = class HealthRegistrar {
 	_checks;
-	_sealed;
+	_ready;
 	constructor() {
 		this._checks = [];
-		this._sealed = false;
+		this._ready = false;
 	}
 	add(healthCheck) {
 		this._checks.push(healthCheck);
 	}
 	/**
-	* @internal used by Sapling library
+	* @internal used by Sapling library, used to determine once all
+	* checks have been registered and server is, at the very least, alive.
 	*/
-	_seal() {
-		this._sealed = true;
+	_markReady() {
+		this._ready = true;
 	}
 	async check() {
-		if (!this._sealed) return false;
+		if (!this._ready) return false;
 		return (await Promise.all(this._checks.map((c) => c()))).every((c) => c === true);
 	}
 };
@@ -494,9 +495,8 @@ var Sapling = class Sapling {
 	* import { Sapling } from "@tahminator/sapling";
 	* import express from "express";
 	*
-	* const app = express();
-	*
-	* app.registerApp(app);
+	* // returns the exact same `express.App` type back to you!
+	* const app = Sapling.registerApp(express());
 	* ```
 	*/
 	static registerApp(app) {
@@ -508,7 +508,7 @@ var Sapling = class Sapling {
 				return function(...args) {
 					const server = originalListen.apply(target, args);
 					server.once("listening", () => {
-						Sapling.onStartup();
+						Sapling.onPostStartup();
 						console.log("Sapling successfully initialized post-startup hooks on server start");
 					});
 					return server;
@@ -517,8 +517,8 @@ var Sapling = class Sapling {
 			return Reflect.get(target, prop, receiver);
 		} });
 	}
-	static onStartup() {
-		_InjectableRegistry.get(HealthRegistrar)?.seal();
+	static onPostStartup() {
+		_InjectableRegistry.get(HealthRegistrar)?._markReady();
 	}
 	/**
 	* Serialize a value into a JSON string.

package/dist/index.d.cts

@@ -843,13 +843,12 @@ declare class Sapling {
    * import { Sapling } from "@tahminator/sapling";
    * import express from "express";
    *
-   * const app = express();
-   *
-   * app.registerApp(app);
+   * // returns the exact same `express.App` type back to you!
+   * const app = Sapling.registerApp(express());
    * ```
    */
   static registerApp(app: e.Express): e.Express;
-  static onStartup(): void;
+  static onPostStartup(): void;
   /**
    * Serialize a value into a JSON string.
    *
@@ -1097,13 +1096,14 @@ declare const DefaultSwaggerMiddleware: {
 type HealthCheck = () => boolean | Promise<boolean>;
 declare class HealthRegistrar {
   private _checks;
-  private _sealed;
+  private _ready;
   constructor();
   add(healthCheck: HealthCheck): void;
   /**
-   * @internal used by Sapling library
+   * @internal used by Sapling library, used to determine once all
+   * checks have been registered and server is, at the very least, alive.
    */
-  _seal(): void;
+  _markReady(): void;
   check(): Promise<boolean>;
 }
 //#endregion

package/dist/index.d.mts

@@ -843,13 +843,12 @@ declare class Sapling {
    * import { Sapling } from "@tahminator/sapling";
    * import express from "express";
    *
-   * const app = express();
-   *
-   * app.registerApp(app);
+   * // returns the exact same `express.App` type back to you!
+   * const app = Sapling.registerApp(express());
    * ```
    */
   static registerApp(app: e.Express): e.Express;
-  static onStartup(): void;
+  static onPostStartup(): void;
   /**
    * Serialize a value into a JSON string.
    *
@@ -1097,13 +1096,14 @@ declare const DefaultSwaggerMiddleware: {
 type HealthCheck = () => boolean | Promise<boolean>;
 declare class HealthRegistrar {
   private _checks;
-  private _sealed;
+  private _ready;
   constructor();
   add(healthCheck: HealthCheck): void;
   /**
-   * @internal used by Sapling library
+   * @internal used by Sapling library, used to determine once all
+   * checks have been registered and server is, at the very least, alive.
    */
-  _seal(): void;
+  _markReady(): void;
   check(): Promise<boolean>;
 }
 //#endregion

package/dist/index.mjs

@@ -376,22 +376,23 @@ function __decorate(decorators, target, key, desc) {
 //#region src/middleware/health/registrar.ts
 let HealthRegistrar = class HealthRegistrar {
 	_checks;
-	_sealed;
+	_ready;
 	constructor() {
 		this._checks = [];
-		this._sealed = false;
+		this._ready = false;
 	}
 	add(healthCheck) {
 		this._checks.push(healthCheck);
 	}
 	/**
-	* @internal used by Sapling library
+	* @internal used by Sapling library, used to determine once all
+	* checks have been registered and server is, at the very least, alive.
 	*/
-	_seal() {
-		this._sealed = true;
+	_markReady() {
+		this._ready = true;
 	}
 	async check() {
-		if (!this._sealed) return false;
+		if (!this._ready) return false;
 		return (await Promise.all(this._checks.map((c) => c()))).every((c) => c === true);
 	}
 };
@@ -469,9 +470,8 @@ var Sapling = class Sapling {
 	* import { Sapling } from "@tahminator/sapling";
 	* import express from "express";
 	*
-	* const app = express();
-	*
-	* app.registerApp(app);
+	* // returns the exact same `express.App` type back to you!
+	* const app = Sapling.registerApp(express());
 	* ```
 	*/
 	static registerApp(app) {
@@ -483,7 +483,7 @@ var Sapling = class Sapling {
 				return function(...args) {
 					const server = originalListen.apply(target, args);
 					server.once("listening", () => {
-						Sapling.onStartup();
+						Sapling.onPostStartup();
 						console.log("Sapling successfully initialized post-startup hooks on server start");
 					});
 					return server;
@@ -492,8 +492,8 @@ var Sapling = class Sapling {
 			return Reflect.get(target, prop, receiver);
 		} });
 	}
-	static onStartup() {
-		_InjectableRegistry.get(HealthRegistrar)?.seal();
+	static onPostStartup() {
+		_InjectableRegistry.get(HealthRegistrar)?._markReady();
 	}
 	/**
 	* Serialize a value into a JSON string.

package/package.json

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