Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICancellationToken

Cancellation token that can be used to listen for and handle cancellation requests

Hierarchy

  • ICancellationToken

Index

Properties

isCancellationRequested

isCancellationRequested: boolean

Whether or not cancellation has been requested

Methods

offCancellation

  • Unregisters an event handler that runs when token cancellation is requested

    Parameters

    Returns void

onCancellation

  • Registers an event handler that runs when token cancellation is requested

    Parameters

    Returns void

throwIfCancellationRequested

  • throwIfCancellationRequested(): void
  • Throws an {@link OperationCanceledError} if cancellation has been requested

    Returns void