Interface CheckpointTriggerResult

Result of triggering a checkpoint

Returned by triggerCheckpoint() to indicate success or failure. Includes error details and partial failure information.

const result: CheckpointTriggerResult = {
  triggered: true,
  checkpointName: 'tests_complete',
  failedCallbacks: 1 // 1 of 3 callbacks failed
};

interface CheckpointTriggerResult {
    triggered: boolean;
    checkpointName: string;
    error?: string;
    failedCallbacks?: number;
}

Properties

triggered: boolean

Whether the checkpoint was triggered (true if at least one callback succeeded)

checkpointName: string

Name of the checkpoint

error?: string

Error message if all callbacks failed

failedCallbacks?: number

Number of callbacks that failed (undefined if all succeeded)