Class CancellationTicket

A Cancellation ticket.

A special ticket that allows coordination of cancellation operations between a requestor and worker.

Index

Constructors

Accessors

none isCancellationRequested

Methods

throwIfCancellationRequested cancel

Constructors

constructor

new CancellationTicket(): CancellationTicket
Returns CancellationTicket

Accessors

`Static`none

get none(): CancellationTicket
Returns CancellationTicket

isCancellationRequested

get isCancellationRequested(): boolean
Whether a cancellation has been requested.

Returns boolean

Methods

throwIfCancellationRequested

throwIfCancellationRequested(): void
Returns void
Throws
Error if isCancellationRequested is set.

cancel

cancel(): Promise<void>
Requests that the coordinated operation be canceled and causes isCancellationRequested to be set.

Returns Promise<void>
A promise that resolves to a bool indicating whether the cancel was successful.