Class SubscribableBase<TSubscriber>

Base class for implementing any subscribable class that expects Disposable for releasing subscriptions.

Type Parameters

  • TSubscriber

Hierarchy

Constructors

constructor

Methods

_getSubscribers _onDispose _unsubscribeAll subscribe unsubscribe unsubscribeAll

Constructors

constructor

Methods

Protected _getSubscribers

  • _getSubscribers(): undefined | ExtendedIterable<TSubscriber>

  • Returns undefined | ExtendedIterable<TSubscriber>

Protected _onDispose

Protected _unsubscribeAll

  • _unsubscribeAll(): undefined

  • Returns undefined

  • _unsubscribeAll(returnSubscribers: false): undefined

  • Parameters

    • returnSubscribers: false

    Returns undefined

  • _unsubscribeAll(returnSubscribers: true): undefined | TSubscriber[]

  • Parameters

    • returnSubscribers: true

    Returns undefined | TSubscriber[]

  • _unsubscribeAll(returnSubscribers: boolean): undefined | TSubscriber[]

  • Parameters

    • returnSubscribers: boolean

    Returns undefined | TSubscriber[]

subscribe

  • Accepts TSubscriber (observer) and returns a Subscription that can be disposed of. The dispose method is scope independent and can be called out of context and still cancel the subscription.

    Returns

    Parameters

    • subscriber: TSubscriber

    Returns default

unsubscribe

  • Unsubscribes the TSubscriber (observer).

    Parameters

    • subscriber: TSubscriber

    Returns void

unsubscribeAll

Settings

Member Visibility

Theme

Generated using TypeDoc