@twin.org/api-server-fastify 0.0.3-next.5 → 0.0.3-next.50

package/dist/types/fastifyWebServer.d.ts

@@ -1,4 +1,5 @@
 import { type IRestRoute, type IRestRouteProcessor, type ISocketRoute, type ISocketRouteProcessor, type IWebServer, type IWebServerOptions } from "@twin.org/api-models";
+import { type IHealth } from "@twin.org/core";
 import { type FastifyInstance } from "fastify";
 import type { IFastifyWebServerConstructorOptions } from "./models/IFastifyWebServerConstructorOptions.js";
 /**
@@ -14,6 +15,11 @@ export declare class FastifyWebServer implements IWebServer<FastifyInstance> {
      * @param options The options for the server.
      */
     constructor(options?: IFastifyWebServerConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Get the web server instance.
      * @returns The web server instance.
@@ -26,17 +32,22 @@ export declare class FastifyWebServer implements IWebServer<FastifyInstance> {
      * @param socketRouteProcessors The processors for incoming requests over Sockets.
      * @param socketRoutes The socket routes.
      * @param options Options for building the server.
-     * @returns Nothing.
+     * @returns A promise that resolves when the server is fully built and ready to start.
      */
     build(restRouteProcessors?: IRestRouteProcessor[], restRoutes?: IRestRoute[], socketRouteProcessors?: ISocketRouteProcessor[], socketRoutes?: ISocketRoute[], options?: IWebServerOptions): Promise<void>;
     /**
      * Start the server.
-     * @returns Nothing.
+     * @returns A promise that resolves when the server is listening for connections.
      */
     start(): Promise<void>;
     /**
      * Stop the server.
-     * @returns Nothing.
+     * @returns A promise that resolves when the server has shut down all connections.
      */
     stop(): Promise<void>;
+    /**
+     * Perform a health check on the server by fetching its own root endpoint.
+     * @returns The health status of the server.
+     */
+    health(): Promise<IHealth[]>;
 }