Context

Get the context of a task run.

Context (ctx) is a way to get information about a run.

The context object does not change whilst your code is executing. This means values like ctx.run.durationMs will be fixed at the moment the run() function is called.

Context example

import { task } from "@trigger.dev/sdk/v3";

export const parentTask = task({
  id: "parent-task",
  run: async (payload: { message: string }, { ctx }) => {
    
    if (ctx.environment.type === "DEVELOPMENT") {
      return;
    }
  },
});

Context properties

task · object

Hide properties

exportName · string

The exported function name of the task e.g. myTask if you defined it like this: export const myTask = task(...).

id · string

The ID of the task.

filePath · string

The file path of the task.

attempt · object

Show properties

id · string

The ID of the execution attempt.

number · number

The attempt number.

startedAt · date

The start time of the attempt.

backgroundWorkerId · string

The ID of the background worker.

backgroundWorkerTaskId · string

The ID of the background worker task.

status · string

The current status of the attempt.

run · object

Show properties

id · string

The ID of the task run.

context · any

The context of the task run.

tags · array

An array of tags associated with the task run.

isTest · boolean

Whether this is a test run.

createdAt · date

The creation time of the task run.

startedAt · date

The start time of the task run.

idempotencyKey · string

An optional idempotency key for the task run.

maxAttempts · number

The maximum number of attempts allowed for this task run.

durationMs · number

The duration of the task run in milliseconds when the run() function is called. For live values use the usage SDK functions.

costInCents · number

The cost of the task run in cents when the run() function is called. For live values use the usage SDK functions.

baseCostInCents · number

The base cost of the task run in cents when the run() function is called. For live values use the usage SDK functions.

version · string

The version of the task run.

maxDuration · number

The maximum allowed duration for the task run.

queue · object

Show properties

id · string

The ID of the queue.

name · string

The name of the queue.

environment · object

Show properties

id · string

The ID of the environment.

slug · string

The slug of the environment.

type · string

The type of the environment (PRODUCTION, STAGING, DEVELOPMENT, or PREVIEW).

organization · object

Show properties

id · string

The ID of the organization.

slug · string

The slug of the organization.

name · string

The name of the organization.

project · object

Show properties

id · string

The ID of the project.

ref · string

The reference of the project.

slug · string

The slug of the project.

name · string

The name of the project.

batch · object

Optional information about the batch, if applicable.

Show properties

id · string

The ID of the batch.

machine · object

Optional information about the machine preset used for execution.

Show properties

name · string

The name of the machine preset.

cpu · number

The CPU allocation for the machine.

memory · number

The memory allocation for the machine.

centsPerMs · number

The cost in cents per millisecond for this machine preset.