# transition

Source: /tuil/docs/reference/packages/workflow/api/transition
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 transition<TState>(
  from: string,
  to: string,
  options: Pick<WorkflowTransition<TState>, "when"> = {},
): WorkflowTransition<TState>;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member    | Type                                       | Required | Description                                                                 | Related types                                                                     |
| --------- | ------------------------------------------ | -------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `from`    | `string`                                   | Yes      | Supplies the `from` value as `string`.                                      | —                                                                                 |
| `to`      | `string`                                   | Yes      | Supplies the `to` value as `string`.                                        | —                                                                                 |
| `options` | `Pick<WorkflowTransition<TState>, "when">` | No       | Supplies the `options` value as `Pick<WorkflowTransition<TState>, "when">`. | [`WorkflowTransition`](/tuil/docs/reference/packages/workflow/api/workflow-transition) |

## Returns [#returns]

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

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

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`WorkflowTransition`](/tuil/docs/reference/packages/workflow/api/workflow-transition)

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