#Class: VoidTaskPromise experimental

Beta

Represents a cancellable Editor task that does not produce a result value.

#Extends

• TaskPromiseBase

#Properties

#cancelled

readonly cancelled: boolean

Beta

#Remarks

Whether cancellation was accepted for the task.

#Inherited from

TaskPromiseBase.cancelled

---

#progress

readonly progress: number

Beta

#Remarks

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.

#Inherited from

TaskPromiseBase.progress

---

#promise

readonly promise: Promise<void>

Beta

#Remarks

The promise that resolves when the task completes. If cancellation is accepted, the promise rejects with a TaskCancelledError.

#Methods

#cancel()

cancel(): void

World Mutation Beta

#Returns

void

#Remarks

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

#Privilege

#Inherited from

TaskPromiseBase.cancel