kotlin-vscode/vscode/CancellationToken

CancellationToken

interface CancellationToken(source)

A cancellation token is passed to an asynchronous or long running operation to request cancellation, like cancelling a request for completion items because the user continued to type.

To get an instance of a CancellationToken use a CancellationTokenSource.

Online Documentation

Properties

isCancellationRequested

abstract external var isCancellationRequested: Boolean

Is true when the token has been cancelled, false otherwise.

onCancellationRequested

abstract external val onCancellationRequested: Event<JsAny?>

An Event which fires upon cancellation.

Functions

asCoroutineScope

fun CancellationToken.asCoroutineScope(): CoroutineScope