chore(): marked the public api in prisma health (#2292)

nestjs · Jun 17, 2023 · 1978022 · 1978022
1 parent 6eab9e6
commit 1978022
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/lib/health-indicator/database/prisma.health.ts b/lib/health-indicator/database/prisma.health.ts
@@ -25,6 +25,13 @@ export interface PrismaClientPingCheckSettings {
   timeout?: number;
 }
 
+/**
+ * The PrismaHealthIndicator contains health indicators
+ * which are used for health checks related to Prisma
+ *
+ * @publicApi
+ * @module TerminusModule
+ */
 export class PrismaHealthIndicator extends HealthIndicator {
   constructor() {
     super();
@@ -52,6 +59,14 @@ export class PrismaHealthIndicator extends HealthIndicator {
     }
   }
 
+  /**
+   * Checks if the Prisma responds in (default) 1000ms and
+   * returns a result object corresponding to the result
+   *
+   * @param key The key which will be used for the result object
+   * @param prismaClient PrismaClient
+   * @param options The options for the ping
+   */
   public async pingCheck(
     key: string,
     prismaClient: PrismaClient,