# createWorkflow

Source: /tuil/docs/reference/packages/workflow/api/create-workflow
Locale: en

function exported by @mwillbanks/tuil-workflow.



{/* Generated by tooling/docs/generate-reference.ts. */}

## function [#function]

Public function exported by `@mwillbanks/tuil-workflow`.

```ts
export function createWorkflow<TState>(
  definition: WorkflowDefinition<TState>,
): WorkflowRunner<TState>;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member       | Type                         | Required | Description                                                      | Related types                                                                     |
| ------------ | ---------------------------- | -------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `definition` | `WorkflowDefinition<TState>` | Yes      | Supplies the `definition` value as `WorkflowDefinition<TState>`. | [`WorkflowDefinition`](/tuil/docs/reference/packages/workflow/api/workflow-definition) |

## Returns [#returns]

`WorkflowRunner<TState>` — Returns a value that satisfies `WorkflowRunner<TState>`.

Related types: [`WorkflowRunner`](/tuil/docs/reference/packages/workflow/api/workflow-runner)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`WorkflowDefinition`](/tuil/docs/reference/packages/workflow/api/workflow-definition)
* [`WorkflowRunner`](/tuil/docs/reference/packages/workflow/api/workflow-runner)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/workflow/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-workflow](/tuil/docs/reference/packages/workflow)