Subscription's name
option, if it was set with method subscribe.
Indicates whether the subscription is live / active.
It can be useful to subscribers when cancelAll is used without their knowledge.
Cancels the live subscription. The subscriber won't receive any more events.
It also sets flag live to false
.
true
- subscription has been successfully cancelledfalse
- nothing happened, as subscription wasn't liveGenerated using TypeDoc
class Subscription
Represents an event subscription, and a safe way to cancel it.
cancel