Options
All
  • Public
  • Public/Protected
  • All
Menu

typed-http-decorators

Index

Namespaces

Enumerations

Interfaces

Type aliases

Variables

Functions

Type aliases

Accepted

Accepted<T>: GetType<typeof Accepted, T>

Type parameters

  • T

Ambiguous

Ambiguous<T>: GetType<typeof Ambiguous, T>

Type parameters

  • T

ArrayToUnion

ArrayToUnion<A>: A extends readonly [infer X, ...infer XS] ? X | ArrayToUnion<XS> : never

Type parameters

  • A

BadGateway

BadGateway<T>: GetType<typeof BadGateway, T>

Type parameters

  • T

BadRequest

BadRequest<T>: GetType<typeof BadRequest, T>

Type parameters

  • T

Conflict

Conflict<T>: GetType<typeof Conflict, T>

Type parameters

  • T

Continue

Continue<T>: GetType<typeof Continue, T>

Type parameters

  • T

Created

Created<T>: GetType<typeof Created, T>

Type parameters

  • T

EarlyHints

EarlyHints<T>: GetType<typeof EarlyHints, T>

Type parameters

  • T

EndpointDecorator

EndpointDecorator<RTS>: TypedPropertyDecorator<(...args: any[]) => Promise<ValueOf<ArrayToUnion<RTS>>>>

Type parameters

ExpectationFailed

ExpectationFailed<T>: GetType<typeof ExpectationFailed, T>

Type parameters

  • T

FailedDependency

FailedDependency<T>: GetType<typeof FailedDependency, T>

Type parameters

  • T

Forbidden

Forbidden<T>: GetType<typeof Forbidden, T>

Type parameters

  • T

Found

Found<T>: GetType<typeof Found, T>

Type parameters

  • T

GatewayTimeout

GatewayTimeout<T>: GetType<typeof GatewayTimeout, T>

Type parameters

  • T

GetEndpointDecorator

GetEndpointDecorator: <RTS>(method: HttpMethod, path: string, options: EndpointOptions<RTS>) => EndpointDecorator<RTS>

Type declaration

GetType

GetType<R, T>: HttpResponse<ReturnType<R>["status"], Type<T>>

Type parameters

Gone

Gone<T>: GetType<typeof Gone, T>

Type parameters

  • T

HttpMethod

HttpMethod: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "ALL" | "OPTIONS" | "HEAD"

HttpResponseOptions

HttpResponseOptions: OverrideOrDefault<HttpResponseOptionsOverrides>

HttpResponseTypeOptions

HttpResponseTypeOptions: OverrideOrDefault<HttpResponseTypeOptionsOverrides>

HttpResponseTypes

HttpResponseTypes: readonly HttpResponseType[]

HttpVersionNotSupported

HttpVersionNotSupported<T>: GetType<typeof HttpVersionNotSupported, T>

Type parameters

  • T

IAmATeapot

IAmATeapot<T>: GetType<typeof IAmATeapot, T>

Type parameters

  • T

InstanceOf

InstanceOf<T>: T extends Type<infer I> ? I : never

Type parameters

  • T

InternalServerError

InternalServerError<T>: GetType<typeof InternalServerError, T>

Type parameters

  • T

LengthRequired

LengthRequired<T>: GetType<typeof LengthRequired, T>

Type parameters

  • T

MethodNotAllowed

MethodNotAllowed<T>: GetType<typeof MethodNotAllowed, T>

Type parameters

  • T

Misdirected

Misdirected<T>: GetType<typeof Misdirected, T>

Type parameters

  • T

MovedPermanently

MovedPermanently<T>: GetType<typeof MovedPermanently, T>

Type parameters

  • T

NoContent

NoContent<T>: GetType<typeof NoContent, T>

Type parameters

  • T

NonAuthoritativeInformation

NonAuthoritativeInformation<T>: GetType<typeof NonAuthoritativeInformation, T>

Type parameters

  • T

NotAcceptable

NotAcceptable<T>: GetType<typeof NotAcceptable, T>

Type parameters

  • T

NotFound

NotFound<T>: GetType<typeof NotFound, T>

Type parameters

  • T

NotImplemented

NotImplemented<T>: GetType<typeof NotImplemented, T>

Type parameters

  • T

NotModified

NotModified<T>: GetType<typeof NotModified, T>

Type parameters

  • T

Ok

Ok<T>: GetType<typeof Ok, T>

Type parameters

  • T

PartialContent

PartialContent<T>: GetType<typeof PartialContent, T>

Type parameters

  • T

PayloadTooLarge

PayloadTooLarge<T>: GetType<typeof PayloadTooLarge, T>

Type parameters

  • T

PaymentRequired

PaymentRequired<T>: GetType<typeof PaymentRequired, T>

Type parameters

  • T

PermanentRedirect

PermanentRedirect<T>: GetType<typeof PermanentRedirect, T>

Type parameters

  • T

PreconditionFailed

PreconditionFailed<T>: GetType<typeof PreconditionFailed, T>

Type parameters

  • T

Processing

Processing<T>: GetType<typeof Processing, T>

Type parameters

  • T

ProxyAuthenticationRequired

ProxyAuthenticationRequired<T>: GetType<typeof ProxyAuthenticationRequired, T>

Type parameters

  • T

RequestTimeout

RequestTimeout<T>: GetType<typeof RequestTimeout, T>

Type parameters

  • T

RequestedRangeNotSatisfiable

RequestedRangeNotSatisfiable<T>: GetType<typeof RequestedRangeNotSatisfiable, T>

Type parameters

  • T

ResetContent

ResetContent<T>: GetType<typeof ResetContent, T>

Type parameters

  • T

ResponseConstructor

ResponseConstructor<Status>: <BodyType>(body: InstanceOf<BodyType>, options?: HttpResponseOptions) => HttpResponse<Status, BodyType>

Type parameters

  • Status: number

Type declaration

ResponseTypeConstructor

ResponseTypeConstructor<Status>: <BodyType>(body: BodyType, options?: HttpResponseTypeOptions) => HttpResponseType<Status, BodyType>

Type parameters

  • Status: number

Type declaration

SeeOther

SeeOther<T>: GetType<typeof SeeOther, T>

Type parameters

  • T

ServiceUnavailable

ServiceUnavailable<T>: GetType<typeof ServiceUnavailable, T>

Type parameters

  • T

SwitchingProtocols

SwitchingProtocols<T>: GetType<typeof SwitchingProtocols, T>

Type parameters

  • T

TemporaryRedirect

TemporaryRedirect<T>: GetType<typeof TemporaryRedirect, T>

Type parameters

  • T

TooManyRequests

TooManyRequests<T>: GetType<typeof TooManyRequests, T>

Type parameters

  • T

Type

Type<T>: {}

Type parameters

  • T = unknown

Type declaration

    TypedPropertyDecorator

    TypedPropertyDecorator<T>: (target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void

    Type parameters

    • T

    Type declaration

      • (target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T> | void

      • Parameters

        • target: Object
        • propertyKey: string | symbol
        • descriptor: TypedPropertyDescriptor<T>

        Returns TypedPropertyDescriptor<T> | void

    Unauthorized

    Unauthorized<T>: GetType<typeof Unauthorized, T>

    Type parameters

    • T

    UnprocessableEntity

    UnprocessableEntity<T>: GetType<typeof UnprocessableEntity, T>

    Type parameters

    • T

    UnsupportedMediaType

    UnsupportedMediaType<T>: GetType<typeof UnsupportedMediaType, T>

    Type parameters

    • T

    UriTooLong

    UriTooLong<T>: GetType<typeof UriTooLong, T>

    Type parameters

    • T

    ValueOf

    ValueOf<RT>: RT extends HttpResponseType<infer Status, infer BodyType> ? HttpResponse<Status, BodyType> : never

    Type parameters

    • RT

    Variables

    Accepted

    Accepted: ResponseConstructor<ACCEPTED> & { Type: ResponseTypeConstructor<ACCEPTED> } = ...

    Ambiguous

    Ambiguous: ResponseConstructor<AMBIGUOUS> & { Type: ResponseTypeConstructor<AMBIGUOUS> } = ...

    BadGateway

    BadGateway: ResponseConstructor<BAD_GATEWAY> & { Type: ResponseTypeConstructor<BAD_GATEWAY> } = ...

    BadRequest

    BadRequest: ResponseConstructor<BAD_REQUEST> & { Type: ResponseTypeConstructor<BAD_REQUEST> } = ...

    Conflict

    Conflict: ResponseConstructor<CONFLICT> & { Type: ResponseTypeConstructor<CONFLICT> } = ...

    Continue

    Continue: ResponseConstructor<CONTINUE> & { Type: ResponseTypeConstructor<CONTINUE> } = ...

    Created

    Created: ResponseConstructor<CREATED> & { Type: ResponseTypeConstructor<CREATED> } = ...

    EarlyHints

    EarlyHints: ResponseConstructor<EARLY_HINTS> & { Type: ResponseTypeConstructor<EARLY_HINTS> } = ...

    ExpectationFailed

    ExpectationFailed: ResponseConstructor<EXPECTATION_FAILED> & { Type: ResponseTypeConstructor<EXPECTATION_FAILED> } = ...

    FailedDependency

    FailedDependency: ResponseConstructor<FAILED_DEPENDENCY> & { Type: ResponseTypeConstructor<FAILED_DEPENDENCY> } = ...

    Forbidden

    Forbidden: ResponseConstructor<FORBIDDEN> & { Type: ResponseTypeConstructor<FORBIDDEN> } = ...

    Found

    Found: ResponseConstructor<FOUND> & { Type: ResponseTypeConstructor<FOUND> } = ...

    GatewayTimeout

    GatewayTimeout: ResponseConstructor<GATEWAY_TIMEOUT> & { Type: ResponseTypeConstructor<GATEWAY_TIMEOUT> } = ...

    Gone

    Gone: ResponseConstructor<GONE> & { Type: ResponseTypeConstructor<GONE> } = ...

    HttpVersionNotSupported

    HttpVersionNotSupported: ResponseConstructor<HTTP_VERSION_NOT_SUPPORTED> & { Type: ResponseTypeConstructor<HTTP_VERSION_NOT_SUPPORTED> } = ...

    IAmATeapot

    IAmATeapot: ResponseConstructor<I_AM_A_TEAPOT> & { Type: ResponseTypeConstructor<I_AM_A_TEAPOT> } = ...

    InternalServerError

    InternalServerError: ResponseConstructor<INTERNAL_SERVER_ERROR> & { Type: ResponseTypeConstructor<INTERNAL_SERVER_ERROR> } = ...

    LengthRequired

    LengthRequired: ResponseConstructor<LENGTH_REQUIRED> & { Type: ResponseTypeConstructor<LENGTH_REQUIRED> } = ...

    MethodNotAllowed

    MethodNotAllowed: ResponseConstructor<METHOD_NOT_ALLOWED> & { Type: ResponseTypeConstructor<METHOD_NOT_ALLOWED> } = ...

    Misdirected

    Misdirected: ResponseConstructor<MISDIRECTED> & { Type: ResponseTypeConstructor<MISDIRECTED> } = ...

    MovedPermanently

    MovedPermanently: ResponseConstructor<MOVED_PERMANENTLY> & { Type: ResponseTypeConstructor<MOVED_PERMANENTLY> } = ...

    NoContent

    NoContent: ResponseConstructor<NO_CONTENT> & { Type: ResponseTypeConstructor<NO_CONTENT> } = ...

    NonAuthoritativeInformation

    NonAuthoritativeInformation: ResponseConstructor<NON_AUTHORITATIVE_INFORMATION> & { Type: ResponseTypeConstructor<NON_AUTHORITATIVE_INFORMATION> } = ...

    NotAcceptable

    NotAcceptable: ResponseConstructor<NOT_ACCEPTABLE> & { Type: ResponseTypeConstructor<NOT_ACCEPTABLE> } = ...

    NotFound

    NotFound: ResponseConstructor<NOT_FOUND> & { Type: ResponseTypeConstructor<NOT_FOUND> } = ...

    NotImplemented

    NotImplemented: ResponseConstructor<NOT_IMPLEMENTED> & { Type: ResponseTypeConstructor<NOT_IMPLEMENTED> } = ...

    NotModified

    NotModified: ResponseConstructor<NOT_MODIFIED> & { Type: ResponseTypeConstructor<NOT_MODIFIED> } = ...

    Ok

    Ok: ResponseConstructor<OK> & { Type: ResponseTypeConstructor<OK> } = ...

    PartialContent

    PartialContent: ResponseConstructor<PARTIAL_CONTENT> & { Type: ResponseTypeConstructor<PARTIAL_CONTENT> } = ...

    PayloadTooLarge

    PayloadTooLarge: ResponseConstructor<PAYLOAD_TOO_LARGE> & { Type: ResponseTypeConstructor<PAYLOAD_TOO_LARGE> } = ...

    PaymentRequired

    PaymentRequired: ResponseConstructor<PAYMENT_REQUIRED> & { Type: ResponseTypeConstructor<PAYMENT_REQUIRED> } = ...

    PermanentRedirect

    PermanentRedirect: ResponseConstructor<PERMANENT_REDIRECT> & { Type: ResponseTypeConstructor<PERMANENT_REDIRECT> } = ...

    PreconditionFailed

    PreconditionFailed: ResponseConstructor<PRECONDITION_FAILED> & { Type: ResponseTypeConstructor<PRECONDITION_FAILED> } = ...

    Processing

    Processing: ResponseConstructor<PROCESSING> & { Type: ResponseTypeConstructor<PROCESSING> } = ...

    ProxyAuthenticationRequired

    ProxyAuthenticationRequired: ResponseConstructor<PROXY_AUTHENTICATION_REQUIRED> & { Type: ResponseTypeConstructor<PROXY_AUTHENTICATION_REQUIRED> } = ...

    RequestTimeout

    RequestTimeout: ResponseConstructor<REQUEST_TIMEOUT> & { Type: ResponseTypeConstructor<REQUEST_TIMEOUT> } = ...

    RequestedRangeNotSatisfiable

    RequestedRangeNotSatisfiable: ResponseConstructor<REQUESTED_RANGE_NOT_SATISFIABLE> & { Type: ResponseTypeConstructor<REQUESTED_RANGE_NOT_SATISFIABLE> } = ...

    ResetContent

    ResetContent: ResponseConstructor<RESET_CONTENT> & { Type: ResponseTypeConstructor<RESET_CONTENT> } = ...

    SeeOther

    SeeOther: ResponseConstructor<SEE_OTHER> & { Type: ResponseTypeConstructor<SEE_OTHER> } = ...

    ServiceUnavailable

    ServiceUnavailable: ResponseConstructor<SERVICE_UNAVAILABLE> & { Type: ResponseTypeConstructor<SERVICE_UNAVAILABLE> } = ...

    SwitchingProtocols

    SwitchingProtocols: ResponseConstructor<SWITCHING_PROTOCOLS> & { Type: ResponseTypeConstructor<SWITCHING_PROTOCOLS> } = ...

    TemporaryRedirect

    TemporaryRedirect: ResponseConstructor<TEMPORARY_REDIRECT> & { Type: ResponseTypeConstructor<TEMPORARY_REDIRECT> } = ...

    TooManyRequests

    TooManyRequests: ResponseConstructor<TOO_MANY_REQUESTS> & { Type: ResponseTypeConstructor<TOO_MANY_REQUESTS> } = ...

    Unauthorized

    Unauthorized: ResponseConstructor<UNAUTHORIZED> & { Type: ResponseTypeConstructor<UNAUTHORIZED> } = ...

    UnprocessableEntity

    UnprocessableEntity: ResponseConstructor<UNPROCESSABLE_ENTITY> & { Type: ResponseTypeConstructor<UNPROCESSABLE_ENTITY> } = ...

    UnsupportedMediaType

    UnsupportedMediaType: ResponseConstructor<UNSUPPORTED_MEDIA_TYPE> & { Type: ResponseTypeConstructor<UNSUPPORTED_MEDIA_TYPE> } = ...

    UriTooLong

    UriTooLong: ResponseConstructor<URI_TOO_LONG> & { Type: ResponseTypeConstructor<URI_TOO_LONG> } = ...

    Functions

    Const either

    • either<XS>(...values: XS): XS

    setEndpointDecorator

    Const t

    • t<XS>(...values: XS): XS

    Generated using TypeDoc