TypeScript SDK

The TypeScript SDK defines durable functions, sends events, and serves your functions from Node.js, Bun, Deno, and edge runtimes. It supports every Inngest feature, including Realtime, Sandboxes (beta), and Agent Evals. See feature support to compare it with the other SDKs.

Install

npm install inngest

Create a client

Create one client for your app. Use it to define functions and send events:

import { Inngest } from "inngest";

export const inngest = new Inngest({ id: "my-app" });

Next, create a function and serve it from your app. The TypeScript quick start walks through a full example.

Reference

Client and events

• Create the client
• Send events
• Trigger helpers

Functions

• Create a function
• Handling failures and cancel on
• Flow control: concurrency, rate limit, debounce, singleton, and priority
• Referencing functions and deferred functions

Steps

• step.run(), step.sleep(), and step.sleepUntil()
• step.waitForEvent() and step.waitForSignal()
• step.invoke(), step.sendEvent(), and step.fetch()
• group.experiment() and scoring (beta)

Serve and run

• Serve configuration and framework handlers
• Streaming and Durable Endpoints (beta)
• Connect workers

Realtime

• Overview, channels and topics, publishing, subscribing, and useRealtime

Middleware

• Lifecycle and examples
• Custom serialization, encryption, and Sentry

Develop and operate

• Environment variables, using TypeScript, and the ESLint plugin
• Testing, logging, and extended traces
• Migrating from v3 to v4

Source code

The TypeScript SDK and its related packages are open source on GitHub: inngest/inngest-js.

Official libraries

• inngest - the Inngest SDK
• @inngest/eslint-plugin - specific ESLint rules for Inngest
• @inngest/middleware-encryption - middleware providing E2E encryption

Examples

Frameworks

• Astro
• Bun.serve()
• Fastify
• Koa
• NestJS
• Next.js (app router)
• Next.js (pages router)
• Nuxt
• Remix
• SvelteKit

Middleware

• E2E Encryption

Community libraries

Explore our collection of community-created libraries, offering unofficial but valuable extensions and integrations to enhance Inngest's functionality with various frameworks and systems.

Want to be added to the list? Contact us!

• nest-inngest - strongly typed Inngest module for NestJS projects
• nuxt-inngest - Inngest integration for Nuxt