ui/client/features/requirement/hooks/useProof

Cockpit client (features), next. Source: ui/client/features/requirement/hooks/useProof.tsx.

Functions#

useProof()#

useProof(state, latest, send): object

Defined in: ui/client/features/requirement/hooks/useProof.tsx:17

The proof of a generated screen: is the plan applied (asked once when a plan is shown, then every couple of seconds while it is approved and its files are not in yet), run the read-only proof, or skip it with a reason. The chain is complete only when the proof is green or skipped; every rule is the server's, this only asks and reports. Nothing here calls a model.

latest is the state the reducer holds, so an answer that arrives after a newer read (a different plan) is dropped.

Parameters#

state

ScreenState

latest

MutableRefObject<ScreenState>

send

(a) => void

Returns#

object

cancelSkip

cancelSkip: () => void

Returns

void

confirmSkip

confirmSkip: () => Promise<void>

Returns

Promise<void>

editSkipReason

editSkipReason: (draft) => void

Parameters

draft

string

Returns

void

openSkip

openSkip: () => void

Returns

void

runProof

runProof: () => Promise<void>

Returns

Promise<void>