Skip to content

Interface: ScheduledTask

Defined in: packages/scheduler/src/interfaces/scheduler.interface.ts:81

Base interface for a scheduled task

Methods

cancel()

ts
cancel(): void;

Defined in: packages/scheduler/src/interfaces/scheduler.interface.ts:95

Cancel the task

Returns

void


getHandle()

ts
getHandle(): TaskHandle;

Defined in: packages/scheduler/src/interfaces/scheduler.interface.ts:105

Get task handle

Returns

TaskHandle


isCanceled()

ts
isCanceled(): boolean;

Defined in: packages/scheduler/src/interfaces/scheduler.interface.ts:100

Check if the task is canceled

Returns

boolean

Properties

PropertyTypeDescriptionDefined in
idstringUnique task identifierpackages/scheduler/src/interfaces/scheduler.interface.ts:85
namestringTask namepackages/scheduler/src/interfaces/scheduler.interface.ts:90

Released under the MIT License.