alepha/server/health.d.ts

Alepha is a convention-driven TypeScript framework for building robust, end-to-end type-safe applications, from serverless APIs to full-stack React apps.

import * as _alepha_core0 from "alepha";
import { Alepha } from "alepha";
import * as _alepha_server0 from "alepha/server";
import { DateTimeProvider } from "alepha/datetime";
import * as _sinclair_typebox0 from "@sinclair/typebox";

//#region src/providers/ServerHealthProvider.d.ts
/**
 * Register `/health` endpoint.
 *
 * - Provides basic health information about the server.
 */
declare class ServerHealthProvider {
  protected readonly time: DateTimeProvider;
  protected readonly alepha: Alepha;
  readonly health: _alepha_server0.RouteDescriptor<{
    response: _sinclair_typebox0.TObject<{
      message: _sinclair_typebox0.TString;
      uptime: _sinclair_typebox0.TNumber;
      date: _sinclair_typebox0.TString;
      ready: _sinclair_typebox0.TBoolean;
    }>;
  }>;
}
//# sourceMappingURL=ServerHealthProvider.d.ts.map
//#endregion
//#region src/index.d.ts
/**
 * Plugin for Alepha Server that provides health-check endpoints.
 *
 * @see {@link ServerHealthProvider}
 * @module alepha.server.health
 */
declare const AlephaServerHealth: _alepha_core0.Service<_alepha_core0.Module>;
//# sourceMappingURL=index.d.ts.map

//#endregion
export { AlephaServerHealth, ServerHealthProvider };
//# sourceMappingURL=index.d.ts.map