Options
All
  • Public
  • Public/Protected
  • All
Menu
class

Represents result of subscribing to an observable object, and a safe way to unsubscribe.

Hierarchy

  • Subscription

Index

Accessors

Methods

Accessors

live

live:

Indicates whether the subscription is live / active.

It can be useful for subscribers when unsubscribe or unsubscribeAll are used without their knowledge.

Methods

unsubscribe

  • unsubscribe(): boolean
  • Unsubscribes from the observable.

    Returns boolean

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

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc