ui/client/features/envelopes/hooks/useRun

Cockpit client (features), next. Source: ui/client/features/envelopes/hooks/useRun.ts.

Functions#

useRun()#

useRun(name, steps, onStarted): RunApi

Defined in: ui/client/features/envelopes/hooks/useRun.ts:12

"Run this flow": the same Process/Approvals path Plan mode's "Run plan" uses. name (the compose draft's loadedFrom, or whatever "Save this flow" was last typed) only labels the process -- running never requires having saved first. onStarted opens the Processes drawer the instant the process starts, same as Plan mode's usePlanScreen(drawer.openProcesses) -- not left to a manual click alone.

Parameters#

name

string | null

steps

ComposeStep[]

onStarted

() => void

Returns#

RunApi