Skip to main content

healthCheck

API Docs

Function: healthCheck()

healthCheck(statusGetter): Promise<{ details: Record<string, unknown>; status: "healthy" | "unhealthy"; }>

Defined in: src/workers/backgroundWorkerService.ts:387

Performs a health check of the background worker service, suitable for use by monitoring systems.

Parameters​

statusGetter​

() => object

Returns​

Promise<{ details: Record<string, unknown>; status: "healthy" | "unhealthy"; }>

  • A promise that resolves to an object indicating the health status and any relevant details.