Skip to content

Latest commit

 

History

History
76 lines (49 loc) · 3.05 KB

README.md

File metadata and controls

76 lines (49 loc) · 3.05 KB
Trigger.dev logo

Open source background jobs with no timeouts

Discord | Website | Issues | Docs

Twitter

About Trigger.dev

Trigger.dev is an open source platform and SDK which allows you to create long-running background jobs with no timeouts. Write normal async code, deploy, and never hit a timeout.

Features:

  • JavaScript and TypeScript SDK
  • Write reliable code by default
  • No infrastructure to manage
  • Works with your existing tech stack

In your codebase

Create tasks where they belong: in your codebase. Version control, localhost, test and review like you're already used to.

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

//1. You need to export each task
export const helloWorld = task({
  //2. Use a unique id for each task
  id: "hello-world",
  //3. The run function is the main function of the task
  run: async (payload: { message: string }) => {
    //4. You can write code that runs for a long time here, there are no timeouts
    console.log(payload.message);
  },
});

Deployment

Use our SDK to write tasks in your codebase. There's no infrastructure to manage, your tasks automatically scale and connect to our cloud. Or you can always self-host.

Environments

We support Development, Staging, and Production environments, allowing you to test your tasks before deploying them to production.

Full visibility of every job run

View every task in every run so you can tell exactly what happened. We provide a full trace view of every task run so you can see what happened at every step.

Trace view image

Getting started

Visit our docs here for a full guide on how to get started with Trigger.dev.

Self-host

If you prefer to self-host, you can follow our self-hosting guide.

Development

To setup and develop locally or contribute to the open source project, follow our development guide.

Meet the Amazing People Behind This Project: