Skip to main content

QFeature

@quik/core

@quik/core / QFeature

Class: QFeature<T>

Defined in: features/QFeature.ts:4

Base object in the Quik Framework.

Extends​

Type Parameters​

T​

T = unknown

Constructors​

Constructor​

new QFeature<T>(instance?, allowUpdate?): QFeature<T>

Defined in: features/QFeature.ts:5

Parameters​

instance?​

T

allowUpdate?​

boolean

Returns​

QFeature<T>

Overrides​

QObject.constructor

Properties​

_allowUpdate​

protected _allowUpdate: boolean = false

Defined in: features/QFeature.ts:11

_instance​

protected _instance: T

Defined in: features/QFeature.ts:17

Accessors​

allowUpdate​

Get Signature​

get allowUpdate(): boolean

Defined in: features/QFeature.ts:13

Returns​

boolean

instance​

Get Signature​

get instance(): T

Defined in: features/QFeature.ts:19

Returns​

T

Set Signature​

set instance(instance): void

Defined in: features/QFeature.ts:26

Parameters​
instance​

T

Returns​

void

logger​

Get Signature​

get protected logger(): IQLogger

Defined in: QObject.ts:15

The logger getter for the object.

Returns​

IQLogger

Inherited from​

QObject.logger

name​

Get Signature​

get name(): string

Defined in: QObject.ts:8

Returns​

string

Inherited from​

QObject.name

Methods​

endSpan()​

protected endSpan(span): void

Defined in: 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: 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: 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: 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