@wpkernel/cli / ReadinessHelper
Interface: ReadinessHelper<State>
Contract implemented by readiness helpers.
Type Parameters
State
State = unknown
Properties
confirm()
ts
readonly confirm: (context, state) => Promise<ReadinessConfirmation<State>>;Parameters
context
state
State
Returns
Promise<ReadinessConfirmation<State>>
detect()
ts
readonly detect: (context) => Promise<ReadinessDetection<State>>;Parameters
context
Returns
Promise<ReadinessDetection<State>>
key
ts
readonly key: ReadinessKey;metadata
ts
readonly metadata: ReadinessHelperMetadata;execute()?
ts
readonly optional execute: (context, state) => Promise<ReadinessStepResult<State>>;Parameters
context
state
State
Returns
Promise<ReadinessStepResult<State>>
prepare()?
ts
readonly optional prepare: (context, state) => Promise<ReadinessStepResult<State>>;Parameters
context
state
State
Returns
Promise<ReadinessStepResult<State>>
rollback()?
ts
readonly optional rollback: (context, state) => Promise<void>;Parameters
context
state
State
Returns
Promise<void>