Type Alias EndpointDefinition

An individual Endpoint definition. customProps (inherited from CommonRouteDefinition via EndpointMethodDefinition) is optional and untyped. Use EndpointDefinitionWithRequiredCustomProps when a wrapper needs to both narrow customProps's type and require its presence on every method.

Package

@rest-vir/api

type EndpointDefinition = {
    path: BaseRoutePath;
    requests: RequireAtLeastOne<
        { [Method in DefinableHttpMethod]: EndpointMethodDefinition<Method> },
    >;
}

Index

Properties

Properties

path

path: BaseRoutePath

requests

requests: RequireAtLeastOne<
{ [Method in DefinableHttpMethod]: EndpointMethodDefinition<Method> },
>