Skip to main content
Version: Next

TaskData

TaskData​

@commandkit/taskstypes.ts

Represents the data structure for a task instance.

This includes the task metadata and any custom data passed to the task.

Signature
interface TaskData<T extends Record<string, any> = Record<string, any>> {
    name: string;
    data: T;
    schedule: TaskSchedule;
    timezone?: string;
    immediate?: boolean;
}

name​

property
string

The name of the task definition to execute

data​

property
T

Custom data passed to the task execution context

schedule​

property
TaskSchedule

Schedule configuration for when the task should run

timezone​

property
string

Optional timezone for the schedule

immediate​

property
boolean

Whether the task should run immediately when created