Interface Transition

Details of a workflow transition.

interface Transition {
    description: string;
    from: string[];
    id: string;
    name: string;
    properties?: {
        [key: string]: unknown;
    };
    rules?: WorkflowRules;
    screen?: TransitionScreenDetails;
    to: string;
    type: "global" | "initial" | "directed";
}

Properties

description from id name properties? rules? screen? to type

Properties

description

description: string

The description of the transition.

from

from: string[]

The statuses the transition can start from.

id

id: string

The ID of the transition.

name

name: string

The name of the transition.

Optionalproperties

properties?: {
    [key: string]: unknown;
}

The properties of the transition.

Type declaration

  • [key: string]: unknown

    The properties of the transition.

Optionalrules

rules?: WorkflowRules

A collection of transition rules.

Optionalscreen

screen?: TransitionScreenDetails

The details of a transition screen.

to

to: string

The status the transition goes to.

type

type: "global" | "initial" | "directed"

The type of the transition.

Settings

Member Visibility

On This Page

Properties