Skip to content

Transition

Since 1.4.0

Transition definition for state machines.

Signature

typescript
interface Transition<Event extends string, From extends string, To extends string> {
  event: Event
  from: From
  to: To
}

Parameters

ParameterDescription
EventEvent name triggering transition
FromSource state
ToTarget state

Description

Defines a state transition triggered by an event.

Examples

Basic Usage

typescript
import type { Transition } from 'uni-types'

type NextTransition = Transition<'next', 'idle', 'loading'>
// { event: 'next'; from: 'idle'; to: 'loading' }

Released under the MIT License.