@nebius/js-sdk - v0.2.54
    Preparing search index...

    Interface OperationProgressTracker

    Reports progress for a long-running operation.

    Operation.progressTracker returns undefined when the service does not provide progress.

    const tracker = op.progressTracker();
    if (tracker) {
      console.log(tracker.description());
      const work = tracker.workFraction();
      if (work !== undefined) console.log(`Work: ${Math.round(work * 100)}%`);
      const time = tracker.timeFraction();
      if (time !== undefined) console.log(`Time: ${Math.round(time * 100)}%`);
    }
    interface OperationProgressTracker {
        "[customJson]"(): unknown;
        description(): string;
        estimatedFinishedAt(): Dayjs | undefined;
        finishedAt(): Dayjs | undefined;
        startedAt(): Dayjs | undefined;
        steps(): CurrentStep[];
        timeFraction(): number | undefined;
        toString(): string;
        workDone(): ProgressTrackerWorkDone | undefined;
        workFraction(): number | undefined;
        [key: symbol]: () => unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: symbol]: () => unknown

      Reports progress for a long-running operation.

      Operation.progressTracker returns undefined when the service does not provide progress.

        • (): unknown

        • Returns a safe value for JSON logs.

          Returns unknown

    Index
    [customJson] description estimatedFinishedAt finishedAt startedAt steps timeFraction toString workDone workFraction

    • Returns the estimated finish time.

      Returns the actual finish time when the operation has finished.

      Returns Dayjs | undefined

    • Returns the elapsed time as a value from 0 to 1.

      Returns undefined when the required times are missing or invalid.

      Returns number | undefined

    • Returns the completed work as a value from 0 to 1.

      Returns undefined when the work counts are missing or invalid.

      Returns number | undefined

    Settings
    Member Visibility

    On This Page
    Methods