Type Alias EndpointImplementationBase<Endpoint, HostContext, ExtraParams>

Generic implementation envelope for a single endpoint. Host and client (mock) reuse this by supplying their own ExtraParams.

Package

@rest-vir/api

type EndpointImplementationBase<
    Endpoint extends Readonly<EndpointDefinition>
    | NoParam = NoParam,
    HostContext = unknown,
    ExtraParams = unknown,
> = {
    definition: Endpoint extends EndpointDefinition
        ? Readonly<Endpoint>
        : Readonly<EndpointDefinition>;
    implementation: Readonly<
        EndpointMethodImplementationsBase<Endpoint, HostContext, ExtraParams>,
    >;
    isEndpoint: true;
    isWebSocket: false;
    path: Endpoint extends EndpointDefinition
        ? Endpoint["path"]
        : BaseRoutePath;
}

Type Parameters

Endpoint extends Readonly<EndpointDefinition> | NoParam = NoParam
HostContext = unknown
ExtraParams = unknown

Index

Properties

definition implementation isEndpoint isWebSocket path

Properties

definition

definition: Endpoint extends EndpointDefinition
? Readonly<Endpoint>
: Readonly<EndpointDefinition>

implementation

implementation: Readonly<
EndpointMethodImplementationsBase<Endpoint, HostContext, ExtraParams>,
>

isEndpoint

isEndpoint: true

isWebSocket

isWebSocket: false

path

path: Endpoint extends EndpointDefinition ? Endpoint["path"] : BaseRoutePath