@tahminator/sapling 2.1.2 → 2.1.3

package/dist/index.d.cts

@@ -853,11 +853,6 @@ declare class Sapling {
    * ```
    */
   static registerApp(app: e.Express): e.Express;
-  /**
-   * @internal
-   * visible for testing
-   */
-  static _onPostStartup(): void;
   /**
    * Serialize a value into a JSON string.
    *
@@ -1130,26 +1125,20 @@ declare class HealthRegistrar {
    * Health checks will be used to determine whether service can serve traffic or not (a.k.a `readiness`).
    */
   add(healthCheck: HealthCheck): void;
-  /**
-   * @internal used by Sapling library, used to determine once all
-   * checks have been registered and server is, at the very least, alive.
-   */
-  _markLive(): void;
-  /**
-   * @internal
-   */
-  _liveness(): Promise<boolean>;
-  /**
-   * @internal
-   */
-  _readiness(): Promise<boolean>;
 }
 //#endregion
 //#region src/middleware/default/health/index.d.ts
 /**
  * Enable the serving of `ready` and `live` endpoints.
  *
- * Configure any middleware-specific settings with `Sapling.Extras.health`
+ * `live` and `ready` endpoint returns 200 with `{ up: true }`, else 503 with `{ up: false }`
+ *
+ * Customize endpoint paths with `Sapling.Extras.health`.
+ * Register readiness checks via {@link HealthRegistrar}.
+ *
+ * explanation of `liveness` vs. `readiness`
+ * @see https://kubernetes.io/docs/concepts/workloads/pods/probes/#liveness-probe
+ * @see https://kubernetes.io/docs/concepts/workloads/pods/probes/#readiness-probe
  */
 declare class DefaultHealthMiddleware {
   private readonly healthRegistrar;

package/dist/index.d.mts

@@ -853,11 +853,6 @@ declare class Sapling {
    * ```
    */
   static registerApp(app: e.Express): e.Express;
-  /**
-   * @internal
-   * visible for testing
-   */
-  static _onPostStartup(): void;
   /**
    * Serialize a value into a JSON string.
    *
@@ -1130,26 +1125,20 @@ declare class HealthRegistrar {
    * Health checks will be used to determine whether service can serve traffic or not (a.k.a `readiness`).
    */
   add(healthCheck: HealthCheck): void;
-  /**
-   * @internal used by Sapling library, used to determine once all
-   * checks have been registered and server is, at the very least, alive.
-   */
-  _markLive(): void;
-  /**
-   * @internal
-   */
-  _liveness(): Promise<boolean>;
-  /**
-   * @internal
-   */
-  _readiness(): Promise<boolean>;
 }
 //#endregion
 //#region src/middleware/default/health/index.d.ts
 /**
  * Enable the serving of `ready` and `live` endpoints.
  *
- * Configure any middleware-specific settings with `Sapling.Extras.health`
+ * `live` and `ready` endpoint returns 200 with `{ up: true }`, else 503 with `{ up: false }`
+ *
+ * Customize endpoint paths with `Sapling.Extras.health`.
+ * Register readiness checks via {@link HealthRegistrar}.
+ *
+ * explanation of `liveness` vs. `readiness`
+ * @see https://kubernetes.io/docs/concepts/workloads/pods/probes/#liveness-probe
+ * @see https://kubernetes.io/docs/concepts/workloads/pods/probes/#readiness-probe
  */
 declare class DefaultHealthMiddleware {
   private readonly healthRegistrar;

package/package.json

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