docs(core): Fix docs for TypeORMHealthCheckStrategy

Closes #2730
vendure-ecommerce · Jul 15, 2024 · 49456b5 · 49456b5
1 parent fe3e455
commit 49456b5
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 13 deletions.
diff --git a/docs/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.md b/docs/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.md
@@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## TypeORMHealthCheckStrategy
 
-<GenerationInfo sourceFile="packages/core/src/health-check/typeorm-health-check-strategy.ts" sourceLine="36" packageName="@vendure/core" />
+<GenerationInfo sourceFile="packages/core/src/health-check/typeorm-health-check-strategy.ts" sourceLine="38" packageName="@vendure/core" />
 
 A <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> used to check the health of the database. This health
 check is included by default, but can be customized by explicitly adding it to the
@@ -24,12 +24,14 @@ import { TypeORMHealthCheckStrategy } from '@vendure/core';
 
 export const config = {
   // ...
-  systemOptions: [
-    // The default key is "database" and the default timeout is 1000ms
-    // Sometimes this is too short and leads to false negatives in the
-    // /health endpoint.
-    new TypeORMHealthCheckStrategy({ key: 'postgres-db', timeout: 5000 }),
-  ]
+  systemOptions: {
+    healthChecks:[
+        // The default key is "database" and the default timeout is 1000ms
+        // Sometimes this is too short and leads to false negatives in the
+        // /health endpoint.
+        new TypeORMHealthCheckStrategy({ key: 'postgres-db', timeout: 5000 }),
+    ]
+  }
 }
 ```
 

diff --git a/packages/core/src/health-check/typeorm-health-check-strategy.ts b/packages/core/src/health-check/typeorm-health-check-strategy.ts
@@ -22,12 +22,14 @@ export interface TypeORMHealthCheckOptions {
  *
  * export const config = {
  *   // ...
- *   systemOptions: [
- *     // The default key is "database" and the default timeout is 1000ms
- *     // Sometimes this is too short and leads to false negatives in the
- *     // /health endpoint.
- *     new TypeORMHealthCheckStrategy({ key: 'postgres-db', timeout: 5000 }),
- *   ]
+ *   systemOptions: {
+ *     healthChecks:[
+ *         // The default key is "database" and the default timeout is 1000ms
+ *         // Sometimes this is too short and leads to false negatives in the
+ *         // /health endpoint.
+ *         new TypeORMHealthCheckStrategy({ key: 'postgres-db', timeout: 5000 }),
+ *     ]
+ *   }
  * }
  * ```
  *