ClassSubscription

Represents an event subscription, and a safe way to cancel it.

See

cancel

Properties

name?

Accessors

live

Methods

cancel

Properties

Optional Readonlyname

name?: string

Subscription's name option, if it was set with method SubEvent.subscribe.

Accessors

live

  • get live(): boolean

  • Indicates whether the subscription is live / active.

    It can be useful to subscribers when SubEvent.cancelAll is used without their knowledge.

    Returns boolean

Methods

cancel

  • cancel(): boolean

  • Cancels the live subscription. The subscriber won't receive any more events.

    It also sets flag live to false.

    Returns boolean

    • true - subscription has been successfully cancelled
    • false - nothing happened, as subscription wasn't live

    See

    SubEvent.cancelAll

Settings

Member Visibility

On This Page

Properties
Accessors
Methods