Script API - v26.50.24
    Preparing search index...

    Class NumberTaskPromise

    Represents a cancellable Editor task that resolves with a numeric result.

    export class NumberTaskPromise extends TaskPromiseBase {
        private constructor();
        readonly promise: Promise<number>;
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    cancelled progress promise

    Methods

    cancel

    Constructors

    Properties

    cancelled: boolean

    Whether cancellation was accepted for the task.

    This property can't be read in early-execution mode.

    progress: number

    The current normalized task progress from 0 to 1. Task groups report the average progress of their constituent tasks. Successful tasks report 1 after settlement; failed or cancelled tasks retain their last observed progress.

    This property can't be read in early-execution mode.

    promise: Promise<number>

    The promise that resolves with the task's numeric result. If cancellation is accepted, the promise rejects with a TaskCancelledError.

    This property can't be read in early-execution mode.

    Methods

    • Returns void

      Requests cancellation of the task. Calling this method more than once, or after the task has settled, has no effect.

      no-restricted-execution - This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods