# WorkflowEvent

Source: /tuil/docs/reference/packages/workflow/api/workflow-event
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 WorkflowEvent<TState> {
  readonly type: WorkflowEventType;
  readonly snapshot: WorkflowSnapshot<TState>;
  readonly step?: string;
  readonly error?: unknown;
  readonly at: number;
}
```

## Members [#members]

| Member     | Type                       | Required | Description                                                         | Related types                                                                    |
| ---------- | -------------------------- | -------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `type`     | `WorkflowEventType`        | Yes      | The `type` member uses the `WorkflowEventType` contract.            | [`WorkflowEventType`](/tuil/docs/reference/packages/workflow/api/workflow-event-type) |
| `snapshot` | `WorkflowSnapshot<TState>` | Yes      | The `snapshot` member uses the `WorkflowSnapshot<TState>` contract. | [`WorkflowSnapshot`](/tuil/docs/reference/packages/workflow/api/workflow-snapshot)    |
| `step`     | `string \| undefined`      | No       | The `step` member uses the `string \| undefined` contract.          | —                                                                                |
| `error`    | `unknown`                  | No       | The `error` member uses the `unknown` contract.                     | —                                                                                |
| `at`       | `number`                   | Yes      | The `at` member uses the `number` contract.                         | —                                                                                |

## 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]

* [`WorkflowEventType`](/tuil/docs/reference/packages/workflow/api/workflow-event-type)
* [`WorkflowSnapshot`](/tuil/docs/reference/packages/workflow/api/workflow-snapshot)

## 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)