docs: Add comments (#3)

a179346 · Sep 18, 2024 · eff0c1f · eff0c1f
1 parent ade3ca5
commit eff0c1f
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 2 deletions.
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -1,6 +1,26 @@
 import { forkJoin, Observable, race, repeat, switchMap, tap, timer } from 'rxjs';
 
+/*!
+ * @rxjs-probe/core
+ *
+ * rxjs-probe provides an interface similar to Kubernetes probes using RxJS to detect service health.
+ *
+ * [GitHub]: https://github.com/a179346/rxjs-probe
+ * [npm]: https://www.npmjs.com/package/@rxjs-probe/core
+ */
+
+/**
+ * ProbePerformer is a class that defines how to perform a health check.
+ *
+ * Use this class to create a custom health check performer.
+ *
+ * Or leverage our predefined health check performers:
+ * - [HttpProbePerformer](https://www.npmjs.com/package/@rxjs-probe/http-probe-performer)
+ */
 export class ProbePerformer {
+  /**
+   * A function that performs the health check. Throw an error if the health check fails.
+   */
   protected readonly _runHealthCheck: (timeoutSeconds: number) => Promise<void> | void;
 
   constructor(runHealthCheck: (timeoutSeconds: number) => Promise<void> | void) {
@@ -28,6 +48,11 @@ export class ProbePerformer {
 
 export type ProbeStatus = 'unknown' | 'healthy' | 'unhealthy';
 
+/**
+ * ProbeConfig is the configuration for a probe.
+ *
+ * Check the [Kubernetes documentation](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes) for more information.
+ */
 export interface ProbeConfig {
   performer: ProbePerformer;
   initialDelaySeconds?: number;

diff --git a/packages/http-probe-performer/package.json b/packages/http-probe-performer/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@rxjs-probe/http-probe-performer",
   "version": "1.0.0-alpha.0",
-  "description": "The probe performer that send HTTP requests to perform the health check.",
+  "description": "The probe performer that send HTTP GET requests to perform the health check.",
   "keywords": [
     "rxjs",
     "probe",
@@ -41,4 +41,4 @@
   "peerDependencies": {
     "@rxjs-probe/core": "*"
   }
-}
+}
diff --git a/packages/http-probe-performer/src/index.ts b/packages/http-probe-performer/src/index.ts
@@ -1,5 +1,19 @@
 import { ProbePerformer } from '@rxjs-probe/core';
 
+/*!
+ * @rxjs-probe/http-probe-performer
+ *
+ * The probe performer that send HTTP GET requests to perform the health check.
+ *
+ * [GitHub]: https://github.com/a179346/rxjs-probe
+ * [npm]: https://www.npmjs.com/package/@rxjs-probe/http-probe-performer
+ */
+
+/**
+ * The configuration for the HTTP probe performer.
+ *
+ * Check the [Kubernetes documentation](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#http-probes) for more information.
+ */
 interface HttpProbePerformerConfig {
   host: string;
   scheme?: 'HTTP' | 'HTTPS';