Skip to main content

healthCheck

API Docs


Function: healthCheck()

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

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

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

Returns

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

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