Context

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.

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

object

Hide properties

string

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

string

The ID of the task.

string

The file path of the task.

object

Show properties

string

The ID of the execution attempt.

number

The attempt number.

date

The start time of the attempt.

string

The ID of the background worker.

string

The ID of the background worker task.

string

The current status of the attempt.

object

Show properties

string

The ID of the task run.

any

The context of the task run.

array

An array of tags associated with the task run.

boolean

Whether this is a test run.

date

The creation time of the task run.

date

The start time of the task run.

string

An optional idempotency key for the task run.

number

The maximum number of attempts allowed for this task run.

number

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

number

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

number

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

string

The version of the task run.

number

The maximum allowed duration for the task run.

object

Show properties

string

The ID of the queue.

string

The name of the queue.

object

Show properties

string

The ID of the environment.

string

The slug of the environment.

string

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

object

Show properties

string

The ID of the organization.

string

The slug of the organization.

string

The name of the organization.

object

Show properties

string

The ID of the project.

string

The reference of the project.

string

The slug of the project.

string

The name of the project.

object

Optional information about the batch, if applicable.

Show properties

string

The ID of the batch.

object

Optional information about the machine preset used for execution.

Show properties

string

The name of the machine preset.

number

The CPU allocation for the machine.

number

The memory allocation for the machine.

number

The cost in cents per millisecond for this machine preset.

Getting started

Fundamentals

Writing tasks

Configuration

Development

Deployment

Frontend usage

Realtime API

CLI

Using the Dashboard

Troubleshooting

Open source

Help

Context properties

​Context properties

Context properties