Defer docs

Platform

Integrations

Guides

References

Console

RescheduleExecutionResult

Introduction

Concepts

Learn how to setup Defer and trigger your first background function.

Next.js

Getting started with Next.js

Express, Koa, hapi

Getting started with Express, Koa or hapi

Nest

Getting started with Nest

RedwoodJS

Getting started with RedwoodJS

Remix

Getting started with Remix

SvelteKit

Getting started with SvelteKit

tRPC/t3 app

Getting started with tRPC

Custom stack

Getting started with a custom stack

Local Development & Testing

Basics

CRON

Control the number of parallel executions

Concurrency

Retries

Delays

Metadata

Cancellation

Discards

Reschedule

Deploy with Github

Node.js

Your application's executions are showing as 'Queued' while none are 'Running'.

Executions are not processing

"My executions are not processing"

Your application's executions are showing as 'Running' for too long.

Executions are stuck

"My executions are stuck"

Your application's executions are marked as 'Failed'.

Executions are failing

"My executions are failing"

Overview

Platform overview

Requirements

Building Environment

Dependencies Installation

Prebuild command

Compilation

Limits

Timezone

Persistence

Running Environment

Arguments and Result

Errors

Network and containers

Automate your Defer environments with integrations

Integrations overview

Use background jobs in Vercel with minimum configuration

Vercel

Vercel integration

Guides overview

Update your Algolia index in real-time or in batches.

Reliable and fast Algolia indexing

Leverage Defer's native puppeteer support with custom resources and long-running executions.

How to run Puppeteer on Node.js without limitations

Prepare your application's data with Defer to generate OpenAI embeddings

Generate embeddings for Supabase Vector

Keep your users informed of long-running workflows progress with Supabase Realtime

Realtime Workflows updates with Supabase Realtime

Process large audio files with ffmpeg and OpenAI Whisper

Process audio files with OpenAI Whisper

Leverage Defer to receive Stripe webhooks in your Next.js application

How to handle Stripe webhooks

Leverage Defer to integrate with the Shopify API and Shopify Webhooks

Build a scalable Shopify App

Leverage JSX with Defer to schedule rich emails

Schedule emails with Resend

How to send a magic-link sign-in email with Defer.

Sending time-sensitive notifications

Example: Perform a Hubspot contact bulk import

Offload your API

Build Todo reminders with cancellable scheduled executions

Create and Manage Reminders

Onboarding workflow

A useful pattern for long-running GraphQL Mutations

GraphQL Bulk actions

Weekly recommendations

Use Turborepo, NPM, Yarn & PNPM workspaces with Defer

Setup Defer with a monorepo

API rate limiting

Enable FIFO executions processing

Leverage the Defer Console filters to narrow down error causes.

Handle common error causes

See how to pass files to your Background functions

Working with files

References overview

defer()

defer.cron()

assignOptions()

delay()

addMetadata()

discardAfter()

awaitResult()

getExecution()

cancelExecution()

rescheduleExecution()

A comprehensive breakdown of all errors thrown by @defer/client.

List executions

Enqueue an execution

Get execution

List execution attempts

Rerun execution

Reschedule execution

Cancel execution

Get execution logs

Get execution results

Get execution arguments

Enqueue Execution

Get Execution

Cancel Execution

@defer/client

HTTP API

RescheduleExecutionResult

Type declaration

@defer/client

HTTP API

​Type declaration

Type declaration