API reference
Inngest API reference
Inngest background jobs and workflows
- Identifiers
- 102
- With full guides
- 0
- Types
- 7
Topics covered
- Functions & events
- Steps
- Retries
- Cron schedules
- Concurrency & throttling
- Fan-out
- Flow control
- Local dev server
Class
| Name | What it does |
|---|
Inngest | Class |
EventSchemas | Class |
NonRetriableError | Class |
RetryAfterError | Class |
InngestMiddleware | Class |
StepError | Class |
Function
| Name | What it does |
|---|
createFunction | Function |
serve | Function |
step.run | Function |
step.sleep | Function |
step.waitForEvent | Function |
step.invoke | Function |
step.sendEvent | Function |
referenceFunction | Function |
inngest.createFunction | Function |
inngest.send | Function |
step.fetch | Function |
Interface
| Name | What it does |
|---|
EventPayload | Interface |
Type Alias
| Name | What it does |
|---|
GetEvents | Type Alias |
ClientOptions | Type Alias |
FunctionOptions | Type Alias |
Context | Type Alias |
StepTools | Type Alias |
InngestFunction | Type Alias |
GetFunctionInput | Type Alias |
Const
| Name | What it does |
|---|
Durable functions | Const |
Flow control | Const |
Fan-out | Const |
Step functions | Const |
Event-driven | Const |
Concurrency control | Const |
Throttling | Const |
Debouncing | Const |
Rate limiting | Const |
Batching | Const |
Idempotency | Const |
Cancellation | Const |
Replay | Const |
Parallelism | Const |
Backoff | Const |
Realtime | Const |
Agent Kit | Const |
Scheduled functions | Const |
Delayed functions | Const |
Local dev server | Const |
Event key | Const |
Signing key | Const |
Function ID | Const |
Multiple triggers | Const |
Cron expressions | Const |
Timezone cron | Const |
Batch timeout | Const |
Batch key | Const |
Concurrency key | Const |
Concurrency scope | Const |
Virtual queue | Const |
Throttle period | Const |
Throttle burst | Const |
Debounce period | Const |
Debounce key | Const |
Rate limit period | Const |
Rate limit key | Const |
Priority expression | Const |
Cancellation event | Const |
Cancellation timeout | Const |
Failure handler | Const |
Step retries | Const |
Sleep duration | Const |
Wait-for-event timeout | Const |
Wait-for-event match | Const |
Invoke timeout | Const |
Multi-step workflow | Const |
Parallel steps | Const |
Sequential steps | Const |
Fan-out pattern | Const |
Step memoization | Const |
Deterministic steps | Const |
Function versioning | Const |
Event payload typing | Const |
Module
| Name | What it does |
|---|
step.sleepUntil | Module |
step.ai.infer | Module |
step.ai.wrap | Module |
Next.js serve | Module |
Express serve | Module |
Remix serve | Module |
Cloudflare serve | Module |
Deno serve | Module |
Lambda serve | Module |
Pipe
| Name | What it does |
|---|
event | Pipe |
cron | Pipe |
batchEvents | Pipe |
concurrency | Pipe |
rateLimit | Pipe |
throttle | Pipe |
debounce | Pipe |
priority | Pipe |
idempotency | Pipe |
cancelOn | Pipe |
retries | Pipe |
timeouts | Pipe |
onFailure | Pipe |
singleton | Pipe |
Search across every package and filter by type in your dashboard.
Start learning