Skip to content

@sibilance.is/client v0.1.0-alpha.4


@sibilance.is/client / index / SurveyCallbacks

Interface: SurveyCallbacks

Defined in: CmdPr/sibilance/client/src/types.ts:205

Callbacks for survey lifecycle events.

Register these callbacks to be notified of survey state changes, completion, errors, and other events.

Properties

PropertyTypeDescriptionDefined in
onComplete?(yaml) => voidCalled when survey is completedCmdPr/sibilance/client/src/types.ts:207
onPause?() => voidCalled when survey is pausedCmdPr/sibilance/client/src/types.ts:209
onEnd?(reason?) => voidCalled when survey is ended earlyCmdPr/sibilance/client/src/types.ts:211
onInformationRecorded?(info) => voidCalled when information is recordedCmdPr/sibilance/client/src/types.ts:213
onStepChange?(stepId) => voidCalled when moving to a new step (for diagram updates)CmdPr/sibilance/client/src/types.ts:215
onResponseRecorded?(stepId, response) => voidCalled when a response is recorded for a step (for diagram updates)CmdPr/sibilance/client/src/types.ts:217
onError?(error) => voidCalled on errorCmdPr/sibilance/client/src/types.ts:219
onTestEnd?() => voidCalled when test is ended (only in test mode with enableTestTools)CmdPr/sibilance/client/src/types.ts:221