Type Alias EndpointMethodImplementationErrorOutput

EndpointMethodImplementationErrorOutput: RequireExactlyOne<
    {
        [Status in ErrorHttpStatus]: {
            headers?: DefaultOutgoingResponseHeadersType;
            responseData: DefaultErrorResponseType;
        }
    },
>

A generic type just for error responses.

Example

function unauthorized(): EndpointMethodImplementationErrorOutput<
    typeof myEndpoint,
    HttpMethod.Get
> {
    return {[HttpStatus.Unauthorized]: {responseData: undefined}};
}

Package

@rest-vir/api

Type Alias EndpointMethodImplementationErrorOutput

Example

Package

Settings