Skip to main content

QRoute

@quik/http

@quik/http / QRoute

Class: QRoute

Defined in: http/src/router/QRoute.ts:8

Base route class containing endpoint and middleware information.

Extends​

  • QObject

Extended by​

Constructors​

Constructor​

new QRoute(): QRoute

Returns​

QRoute

Inherited from​

QObject.constructor

Properties​

_basePath​

protected _basePath: string = "/"

Defined in: http/src/router/QRoute.ts:21

_condition​

protected _condition: () => boolean

Defined in: http/src/router/QRoute.ts:9

Returns​

boolean

_endpoints​

protected _endpoints: IQEndpointDefinition[] = []

Defined in: http/src/router/QRoute.ts:27

_engineMiddlewares​

protected _engineMiddlewares: unknown[] = []

Defined in: http/src/router/QRoute.ts:39

_flags​

protected _flags: string[] = []

Defined in: http/src/router/QRoute.ts:15

_middlewares​

protected _middlewares: QEndpointMiddleware[] = []

Defined in: http/src/router/QRoute.ts:33

Accessors​

basePath​

Get Signature​

get basePath(): string

Defined in: http/src/router/QRoute.ts:23

Returns​

string

condition​

Get Signature​

get condition(): () => boolean

Defined in: http/src/router/QRoute.ts:11

Returns​

() => boolean

endpoints​

Get Signature​

get endpoints(): IQEndpointDefinition[]

Defined in: http/src/router/QRoute.ts:29

Returns​

IQEndpointDefinition[]

engineMiddlewares​

Get Signature​

get engineMiddlewares(): unknown[]

Defined in: http/src/router/QRoute.ts:41

Returns​

unknown[]

flags​

Get Signature​

get flags(): string[]

Defined in: http/src/router/QRoute.ts:17

Returns​

string[]

logger​

Get Signature​

get protected logger(): IQLogger

Defined in: core/src/QObject.ts:15

The logger getter for the object.

Returns​

IQLogger

Inherited from​

QObject.logger

middlewares​

Get Signature​

get middlewares(): QEndpointMiddleware[]

Defined in: http/src/router/QRoute.ts:35

Returns​

QEndpointMiddleware[]

name​

Get Signature​

get name(): string

Defined in: core/src/QObject.ts:8

Returns​

string

Inherited from​

QObject.name

Methods​

endSpan()​

protected endSpan(span): void

Defined in: core/src/QObject.ts:35

End a span returned by startSpan.

Parameters​

span​

TelemetrySpan

The span to end.

Returns​

void

Inherited from​

QObject.endSpan

recordSpanError()​

protected recordSpanError(span, err): void

Defined in: core/src/QObject.ts:45

Record an exception on an active span.

Parameters​

span​

TelemetrySpan

The span to record the error on.

err​

unknown

The error to record.

Returns​

void

Inherited from​

QObject.recordSpanError

setSpanAttribute()​

protected setSpanAttribute(span, key, value): void

Defined in: core/src/QObject.ts:64

Set a single attribute on an active span.

Parameters​

span​

TelemetrySpan

The span to update.

key​

string

Attribute key.

value​

string | number | boolean

Attribute value.

Returns​

void

Inherited from​

QObject.setSpanAttribute

startSpan()​

protected startSpan(spanName, options?): TelemetrySpan

Defined in: core/src/QObject.ts:26

Start a telemetry span for the given operation name. Returns undefined when no telemetry provider is active.

Parameters​

spanName​

string

Name of the span.

options?​

TelemetrySpanOptions

Optional span attributes and kind.

Returns​

TelemetrySpan

Inherited from​

QObject.startSpan

toObject()​

toObject(): Record<string, any>

Defined in: http/src/router/QRoute.ts:48

Return a plain object representation of the route.

Returns​

Record<string, any>