createHealthCheckMiddleware

createHealthCheckMiddleware(bridgeOrRouter, path, config?): (req, res) => Promise<boolean>

Defined in: health.ts:278

Create simple health check middleware

Parameters

bridgeOrRouter

Bridge or Router instance

Bridge<FrontendAdapter<unknown, unknown, unknown>> | Router

path

string = '/health'

Health check path (default: ‘/health’)

config?

HealthCheckConfig

Health check configuration

Returns

Middleware function

(req, res): Promise<boolean>

Parameters

req

GenericRequest

res

GenericResponse

Returns

Promise<boolean>

Example

import { createHealthCheckMiddleware } from 'ai.matey.http';

const healthMiddleware = createHealthCheckMiddleware(bridge);

// Use in HTTP server
app.use(healthMiddleware);