Skip to main content

EndpointContextMetadata

@quik/http


@quik/http / HttpMetadataUtils / EndpointContextMetadata

Type Alias: EndpointContextMetadata

EndpointContextMetadata = Record<PropertyKey, unknown> & object

Defined in: http/src/router/decorators/Metadata.ts:24

Type Declaration

alias?

optional alias?: string

condition?

optional condition?: () => boolean

Returns

boolean

contentType?

optional contentType?: string

description?

optional description?: string

engineMiddlewares

engineMiddlewares: unknown[]

flags

flags: string[]

middlewares

middlewares: QEndpointMiddleware[]

name

name: string

others

others: Record<string, unknown>

parameters

parameters: EndpointParametersDefinition

path

path: string

requestType?

optional requestType?: string

responses

responses: Record<QHTTPStatus, EndpointResponseDefinition>

summary?

optional summary?: string

verb

verb: QHTTPVerb