UNPKG

840 BTypeScriptView Raw
1import { SdmGoalEvent } from "../SdmGoalEvent";
2/**
3 * Signals a certain phase was entered during Goal execution.
4 */
5export interface Progress {
6 /** Simple string label indicating the phase */
7 phase?: string;
8}
9/**
10 * Report on the Progress of a Goal execution based on given log extract.
11 * Usually this is the most current log line produced by the Goal execution.
12 *
13 * The returned Progress.phase will be stored on the Goal and overridden when
14 * a new phase has been reported.
15 *
16 * If the goal fails, the failing phase is preserved. In all other cases the
17 * phase will be reset on goal completion.
18 */
19export declare type ReportProgress = (log: string, sdmGoal: SdmGoalEvent) => Progress;
20/**
21 * Don't report any progress
22 */
23export declare const NoProgressReport: ReportProgress;
24//# sourceMappingURL=ReportProgress.d.ts.map
\No newline at end of file