ui/client/features/requirement/hooks/useRequirement

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

Functions#

useRequirement()#

useRequirement(onApproved): object

Defined in: ui/client/features/requirement/hooks/useRequirement.tsx:22

The Requirement screen: a sentence is read into a card, a placement, a plan and a timeline by the server's deterministic blocks; a person answers the closed questions, then approves the plan. Approving hands the plan to the Plan screen's own run route (per-file approval, containment and the session gate are that route's, unchanged). Nothing here calls a model.

latest is the state the reducer holds, advanced in the same order as send, so an action that starts right after another reads the text and answers just set. seq drops the answer of a read that a newer one overtook.

Parameters#

onApproved

() => void

Returns#

object

answer

answer: (question, option) => Promise<void>

Parameters

question

AnswerTarget

option

string

Returns

Promise<void>

approve

approve: () => Promise<void>

Returns

Promise<void>

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

pickExample

pickExample: (text) => Promise<void>

Parameters

text

string

Returns

Promise<void>

read

read: () => Promise<void>

Returns

Promise<void>

runProof

runProof: () => Promise<void>

Returns

Promise<void>

saveNote

saveNote: () => Promise<void>

Returns

Promise<void>

setText

setText: (text) => void

Parameters

text

string

Returns

void

state

state: ScreenState