# WorkflowContext

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

interface exported by @mwillbanks/tuil-workflow.



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

## interface [#interface]

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

```ts
export interface WorkflowContext<TState> {
  readonly state: TState;
  readonly signal: AbortSignal;
  readonly runner: WorkflowRunner<TState>;
}
```

## Members [#members]

| Member   | Type                     | Required | Description                                                     | Related types                                                             |
| -------- | ------------------------ | -------- | --------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `state`  | `TState`                 | Yes      | The `state` member uses the `TState` contract.                  | —                                                                         |
| `signal` | `AbortSignal`            | Yes      | The `signal` member uses the `AbortSignal` contract.            | —                                                                         |
| `runner` | `WorkflowRunner<TState>` | Yes      | The `runner` member uses the `WorkflowRunner<TState>` contract. | [`WorkflowRunner`](/tuil/docs/reference/packages/workflow/api/workflow-runner) |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`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)