Line

You are reading the unreleased docs (next). See latest (v0.9)

ui/client/features/workflows/domain/MachineBehavior

Cockpit client (features), next. Source: ui/client/features/workflows/domain/MachineBehavior.tsx.

Type Aliases#

MachineBehavior#

MachineBehavior = object

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:11

Properties#

actions

actions: NamedUsage[]

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:13

context

context: WorkflowContextField[]

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:12

guards

guards: NamedUsage[]

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:14

transitions

transitions: TransitionChoice[]

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:15


NamedUsage#

NamedUsage = object

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:7

Properties#

declared

declared: boolean

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:7

name

name: string

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:7

usedBy

usedBy: string[]

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:7


TransitionChoice#

TransitionChoice = object

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:9

Properties#

event

event: string

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:9

from

from: string

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:9

key

key: string

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:9

kind

kind: NonNullable<WorkflowMachine["transitions"][number]["kind"]>

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:9

label

label: string

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:9

Functions#

describeBehavior()#

describeBehavior(machine): MachineBehavior

Defined in: ui/client/features/workflows/domain/MachineBehavior.tsx:28

Group a machine's actions and guards by name, with everywhere each is used.

Parameters#

machine

WorkflowMachine

Returns#

MachineBehavior