Function: progress()

function progress(percent, message): ProgressEvent;

Defined in: packages/core/src/core/execution/ProgressHelper.ts:72

Create a progress event to yield from a generator handler.

Parameters

Parameter	Type	Description
percent	number	Completion percentage (0–100)
message	string	Human-readable status message

Returns

ProgressEvent

A ProgressEvent to be yielded

Example

handler: async function* (ctx, args) {
    yield progress(10, 'Starting...');
    // ... work ...
    yield progress(90, 'Almost done...');
    return success('Done');
}