CancelSignal Interface

    Package: @esfx/cancelable

    An object that represents a cancellation signal.

    Declaration
    export interface CancelSignal 

    Properties

    reason

    Gets the reason cancellation was signaled.

    Declaration
    readonly reason: unknown;
    Property Value
    unknown

    signaled

    Gets a value indicating whether cancellation was signaled.

    Declaration
    readonly signaled: boolean;
    Property Value
    boolean

    Methods

    subscribe(onSignaled)

    Subscribes to notifications for when the object becomes signaled.

    Declaration
    subscribe(onSignaled: () => void): CancelSubscription;
    Parameters
    onSignaled
    () => void

    Returns
    CancelSubscription

    Generated by DocFX