Interface ServerInstance<Ctx, Ports>

Runtime server object returned by createServer(...).

interface ServerInstance<Ctx, Ports extends AnyPorts = AnyPorts> {
    api: (req: HttpRequestLike) => Promise<HttpResponse>;
    contracts: readonly HttpContractConfig[];
    ports: Ports;
    route: <CLike extends ContractLike>(
        contractLike: CLike,
    ) => RouteBuilder<Ctx, ResolveContract<CLike>>;
    stop: () => Promise<void>;
}

Type Parameters

Ctx
Ports extends AnyPorts = AnyPorts

Index

Properties

api contracts ports route stop

Properties

api

api: (req: HttpRequestLike) => Promise<HttpResponse>

Catch-all request handler for platform adapters.

contracts

contracts: readonly HttpContractConfig[]

Contract configs registered through the routes option.

ports

ports: Ports

Final app ports after provider setup.

route

route: <CLike extends ContractLike>(
contractLike: CLike,
) => RouteBuilder<Ctx, ResolveContract<CLike>>

Register and build a single route handler imperatively.

stop

stop: () => Promise<void>

Stop installed providers in reverse setup order.