Line

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

ui/client/features/plan/hooks/usePlanRun

Cockpit client (features), next. Source: ui/client/features/plan/hooks/usePlanRun.tsx.

Type Aliases#

RunNote#

RunNote = object

Defined in: ui/client/features/plan/hooks/usePlanRun.tsx:8

What Run needs of the durable note: save it first and name it, then take the server's "ran" copy.

Properties#

flush

flush: () => Promise<string | null>

Defined in: ui/client/features/plan/hooks/usePlanRun.tsx:8

Returns

Promise<string | null>

resync

resync: (id) => Promise<void>

Defined in: ui/client/features/plan/hooks/usePlanRun.tsx:8

Parameters
id

string

Returns

Promise<void>

Functions#

usePlanRun()#

usePlanRun(plan, dispatch, onStarted, note): () => Promise<void>

Defined in: ui/client/features/plan/hooks/usePlanRun.tsx:11

Run plan: the server re-validates the plan itself and only then creates and starts the process, and marks the note ran.

Parameters#

plan

PlanDoc

dispatch

Dispatch<ScreenAction>

onStarted

() => void

note

RunNote

Returns#

() => Promise<void>