Class SubscribableBase<TSubscriber>

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

Type Parameters

TSubscriber

Hierarchy (View Summary)

default
- SubscribableBase
  - ObservableBase

Index

Constructors

Methods

_getSubscribers _onDispose _unsubscribeAll subscribe unsubscribe unsubscribeAll

Constructors

constructor

new SubscribableBase<TSubscriber>(): SubscribableBase<TSubscriber>
Type Parameters
- TSubscriber
Returns SubscribableBase<TSubscriber>
Overrides DisposableBase.constructor
- Defined in SubscribableBase.ts:19

Methods

`Protected`_getSubscribers

_getSubscribers(): undefined | ExtendedIterable<TSubscriber>
Returns undefined | ExtendedIterable<TSubscriber>
- Defined in SubscribableBase.ts:66

`Protected`_onDispose

_onDispose(): void
Returns void
Overrides DisposableBase._onDispose
- Defined in SubscribableBase.ts:87

`Protected`_unsubscribeAll

_unsubscribeAll(): undefined
Returns undefined
- Defined in SubscribableBase.ts:71
_unsubscribeAll(returnSubscribers: false): undefined
Parameters
- returnSubscribers: false
Returns undefined
- Defined in SubscribableBase.ts:72
_unsubscribeAll(returnSubscribers: true): undefined | TSubscriber[]
Parameters
- returnSubscribers: true
Returns undefined | TSubscriber[]
- Defined in SubscribableBase.ts:73
_unsubscribeAll(returnSubscribers: boolean): undefined | TSubscriber[]
Parameters
- returnSubscribers: boolean
Returns undefined | TSubscriber[]
- Defined in SubscribableBase.ts:74

subscribe(subscriber: TSubscriber): Disposable
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.
Parameters
- subscriber: TSubscriber
Returns Disposable
- Defined in SubscribableBase.ts:32

unsubscribe

unsubscribe(subscriber: TSubscriber): void
Unsubscribes the TSubscriber (observer).
Parameters
- subscriber: TSubscriber
Returns void
- Defined in SubscribableBase.ts:53

unsubscribeAll

unsubscribeAll(): void
Cancels (disposes) all subscriptions.

Returns void
- Defined in SubscribableBase.ts:61