Creates a CancellationToken corresponding to an asynchronous process with multiple consumers. It is cancelled only when the cancellation tokens corresponding to all of the consumers have been cancelled.

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

consumers: Set<CancellationToken> = ...

Accessors

Methods

  • Add a cancellation handler function. The handler will be invoked synchronously if this.isCanceled === true. Otherwise, it will be invoked synchronously upon cancellation, unless it is removed prior to cancellation.

    The handler function must not throw any exceptions when called.

    Precondition

    The handler function must not already be registered.

    Returns

    A function that unregisters the handler.

    Parameters

    • handler: (() => void)

      The handler function to add.

        • (): void
        • Returns void

    Returns (() => void)

      • (): void
      • Returns void

  • Unregister a cancellation handler function. If this.isCanceled, or the specified handler function has not been registered, then this function has no effect.

    Parameters

    • handler: (() => void)
        • (): void
        • Returns void

    Returns void

Generated using TypeDoc