@dxos/app-toolkit - v0.16.0
    Preparing search index...

    Type Alias ProgressReporter

    Reports one run's progress as Trace.StatusUpdate events, which the progress trace sink projects into a meter. A run reports its total once the work is known, advances as items are done, and ends with ProgressReporter.end (or complete / fail).

    type ProgressReporter = {
        advance: (count?: number) => void;
        complete: () => void;
        end: (exit: Exit.Exit<unknown, unknown>) => void;
        fail: () => void;
        total: (total: number) => void;
    }
    Index

    Properties

    advance complete end fail total

    Properties

    advance: (count?: number) => void

    Counts count more items done (one by default). A count past the total raises the total with it.

    complete: () => void
    end: (exit: Exit.Exit<unknown, unknown>) => void

    Ends the meter with the run's outcome: complete on success, cancelled on interruption, failed otherwise.

    fail: () => void
    total: (total: number) => void

    The run's total, once known. Never set below the count already reported.

    Settings

    Member Visibility

    On This Page

    Properties