TanStack
Workflow v0v0
Docs
Cloudflare
Railway
CodeRabbit
AG Grid
OpenRouter
Clerk
SerpAPI
Netlify
WorkOS
Electric
Prisma
Sentry
Unkey
Cloudflare
Railway
CodeRabbit
AG Grid
OpenRouter
Clerk
SerpAPI
Netlify
WorkOS
Electric
Prisma
Sentry
Unkey
Menu
Getting Started
Guide
Cookbook
Concepts
API Reference

WorkflowDefinition

Interface: WorkflowDefinition<TInput, TOutput, TState>

Defined in: packages/workflow-core/src/types.ts:415

Type Parameters

TInput

TInput = unknown

TOutput

TOutput = unknown

TState

TState = Record<string, unknown>

Properties

__kind

ts
__kind: "workflow";
__kind: "workflow";

Defined in: packages/workflow-core/src/types.ts:420

defaultStepRetry?

ts
optional defaultStepRetry: StepRetryOptions;
optional defaultStepRetry: StepRetryOptions;

Defined in: packages/workflow-core/src/types.ts:434

description?

ts
optional description: string;
optional description: string;

Defined in: packages/workflow-core/src/types.ts:422

handler()

ts
handler: (ctx) => Promise<TOutput>;
handler: (ctx) => Promise<TOutput>;

Defined in: packages/workflow-core/src/types.ts:436

Parameters

ctx

any

Returns

Promise<TOutput>

id

ts
id: string;
id: string;

Defined in: packages/workflow-core/src/types.ts:421

initialize()?

ts
optional initialize: (args) => Partial<TState>;
optional initialize: (args) => Partial<TState>;

Defined in: packages/workflow-core/src/types.ts:433

Parameters

args
input

TInput

Returns

Partial<TState>

inputSchema?

ts
optional inputSchema: SchemaInput;
optional inputSchema: SchemaInput;

Defined in: packages/workflow-core/src/types.ts:430

middlewares

ts
middlewares: readonly AnyMiddleware[];
middlewares: readonly AnyMiddleware[];

Defined in: packages/workflow-core/src/types.ts:435

outputSchema?

ts
optional outputSchema: SchemaInput;
optional outputSchema: SchemaInput;

Defined in: packages/workflow-core/src/types.ts:431

previousVersions?

ts
optional previousVersions: readonly WorkflowDefinition<any, any, any>[];
optional previousVersions: readonly WorkflowDefinition<any, any, any>[];

Defined in: packages/workflow-core/src/types.ts:429

Older versions of this workflow that may still have in-flight runs. The engine routes a run's resume call to the version whose identifier matches the run's persisted workflowVersion.

stateSchema?

ts
optional stateSchema: SchemaInput;
optional stateSchema: SchemaInput;

Defined in: packages/workflow-core/src/types.ts:432

version?

ts
optional version: string;
optional version: string;

Defined in: packages/workflow-core/src/types.ts:425

Caller-supplied version identifier. Used with previousVersions and selectWorkflowVersion for cross-version routing.

Edit on GitHub
Home
© 2026 TanStack LLC