Type Alias ApiDefinition<EndpointPaths, WebSocketPaths>

Output of defineApi. Path-keyed records of Endpoints and WebSockets, narrowed to the path literals found in the input arrays.

Package

@rest-vir/api

type ApiDefinition<
    EndpointPaths extends BaseRoutePath = BaseRoutePath,
    WebSocketPaths extends BaseRoutePath = BaseRoutePath,
> = {
    apiName: string;
    endpoints: Readonly<Record<EndpointPaths, Readonly<EndpointDefinition>>>;
    webSockets: Readonly<Record<WebSocketPaths, Readonly<WebSocketDefinition>>>;
}

Type Parameters

EndpointPaths extends BaseRoutePath = BaseRoutePath
WebSocketPaths extends BaseRoutePath = BaseRoutePath

Index

Properties

apiName endpoints webSockets

Properties

apiName

apiName: string

endpoints

endpoints: Readonly<Record<EndpointPaths, Readonly<EndpointDefinition>>>

webSockets

webSockets: Readonly<Record<WebSocketPaths, Readonly<WebSocketDefinition>>>