Skip to main content

QTask

@quik/scheduler

@quik/scheduler / QTask

Abstract Class: QTask

Defined in: scheduler/src/QTask.ts:10

Base class for scheduled tasks.

Extends​

  • QObject

Constructors​

Constructor​

protected new QTask(nameOrExecutionPlan, executionPlan?): QTask

Defined in: scheduler/src/QTask.ts:17

Create a new task instance.

Parameters​

nameOrExecutionPlan​

string | IQExecutionPlan

Task name or execution plan.

executionPlan?​

string | IQExecutionPlan

Optional execution plan when a custom name is provided.

Returns​

QTask

Overrides​

QObject.constructor

Properties​

_disableDatabaseLogging​

protected _disableDatabaseLogging: boolean = false

Defined in: scheduler/src/QTask.ts:34

_executionPlan​

protected _executionPlan: string | IQExecutionPlan

Defined in: scheduler/src/QTask.ts:51

Execution plan or cron expression for the task.

_taskName​

protected _taskName: string

Defined in: scheduler/src/QTask.ts:41

Internal task name.

Accessors​

disableDatabaseLogging​

Get Signature​

get disableDatabaseLogging(): boolean

Defined in: scheduler/src/QTask.ts:36

Returns​

boolean

executionPlan​

Get Signature​

get executionPlan(): string | IQExecutionPlan

Defined in: scheduler/src/QTask.ts:56

Execution plan for the task.

Returns​

string | IQExecutionPlan

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

name​

Get Signature​

get name(): string

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

Returns​

string

Inherited from​

QObject.name

taskName​

Get Signature​

get taskName(): string

Defined in: scheduler/src/QTask.ts:46

Name of the task.

Returns​

string

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

run()​

abstract run(): Promise<void>

Defined in: scheduler/src/QTask.ts:63

Implement task logic here.

Returns​

Promise<void>

setDisableDatabaseLogging()​

protected setDisableDatabaseLogging(): void

Defined in: scheduler/src/QTask.ts:65

Returns​

void

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