Class ObservableBase<T>`Abstract`

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

Type Parameters

Hierarchy

SubscribableBase<Observer<T>>
- ObservableBase
  - ObservableNodeBase

Implements

Observable<T>

Index

Constructors

constructor

Methods

_getSubscribers _onCompleted _onDispose _onError _onNext _unsubscribeAll subscribe unsubscribe unsubscribeAll

Constructors

constructor

new ObservableBase<T>(): ObservableBase<T>
Type Parameters
- T
Returns ObservableBase<T>
Inherited from SubscribableBase.constructor
- Defined in SubscribableBase.ts:23

Methods

`Protected` _getSubscribers

_getSubscribers(): undefined | ExtendedIterable<Observer<T>>
Returns undefined | ExtendedIterable<Observer<T>>
Inherited from SubscribableBase._getSubscribers
- Defined in SubscribableBase.ts:71

`Protected` _onCompleted

_onCompleted(): void
Returns void
- Defined in ObservableBase.ts:63

`Protected` _onDispose

_onDispose(): void
Returns void
Inherited from SubscribableBase._onDispose
- Defined in SubscribableBase.ts:93

`Protected` _onError

_onError(error: unknown): void
Parameters
- error: unknown
Returns void
- Defined in ObservableBase.ts:55

`Protected` _onNext

_onNext(value: T): void
Parameters
- value: T
Returns void
- Defined in ObservableBase.ts:47

`Protected` _unsubscribeAll

_unsubscribeAll(): undefined
Returns undefined
Inherited from SubscribableBase._unsubscribeAll
- Defined in SubscribableBase.ts:76
_unsubscribeAll(returnSubscribers: false): undefined
Parameters
- returnSubscribers: false
Returns undefined
Inherited from SubscribableBase._unsubscribeAll
- Defined in SubscribableBase.ts:77
_unsubscribeAll(returnSubscribers: true): undefined | Observer<T>[]
Parameters
- returnSubscribers: true
Returns undefined | Observer<T>[]
Inherited from SubscribableBase._unsubscribeAll
- Defined in SubscribableBase.ts:78
_unsubscribeAll(returnSubscribers: boolean): undefined | Observer<T>[]
Parameters
- returnSubscribers: boolean
Returns undefined | Observer<T>[]
Inherited from SubscribableBase._unsubscribeAll
- Defined in SubscribableBase.ts:79

subscribe(subscriber: Observer<T>): default
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: Observer<T>
Returns default
Implementation of Observable.subscribe

Overrides SubscribableBase.subscribe
- Defined in ObservableBase.ts:21
subscribe(subscriber: Action<T>, onError?: Action<any>, onCompleted?: Closure): default
Parameters
- subscriber: Action<T>
- Optional onError: Action<any>
- Optional onCompleted: Closure
Returns default
Implementation of Observable.subscribe

Overrides SubscribableBase.subscribe
- Defined in ObservableBase.ts:23

unsubscribe

unsubscribe(subscriber: Observer<T>): void
Unsubscribes the TSubscriber (observer).
Parameters
- subscriber: Observer<T>
Returns void
Implementation of Observable.unsubscribe

Inherited from SubscribableBase.unsubscribe
- Defined in SubscribableBase.ts:58

unsubscribeAll

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

Returns void
Inherited from SubscribableBase.unsubscribeAll
- Defined in SubscribableBase.ts:66

Class ObservableBase<T>Abstract

Type Parameters

T

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

T

Returns ObservableBase<T>

Methods

Protected _getSubscribers

Returns undefined | ExtendedIterable<Observer<T>>

Protected _onCompleted

Returns void

Protected _onDispose

Returns void

Protected _onError

Parameters

error: unknown

Returns void

Protected _onNext

Parameters

value: T

Returns void

Protected _unsubscribeAll

Returns undefined

Parameters

returnSubscribers: false

Returns undefined

Parameters

returnSubscribers: true

Returns undefined | Observer<T>[]

Parameters

returnSubscribers: boolean

Returns undefined | Observer<T>[]

subscribe

Returns

Parameters

subscriber: Observer<T>

Returns default

Parameters

subscriber: Action<T>

Optional onError: Action<any>

Optional onCompleted: Closure

Returns default

unsubscribe

Parameters

subscriber: Observer<T>

Returns void

unsubscribeAll

Returns void

Settings

Member Visibility

Theme

Class ObservableBase<T>`Abstract`

`Protected` _getSubscribers

`Protected` _onCompleted

`Protected` _onDispose

`Protected` _onError

`Protected` _onNext

`Protected` _unsubscribeAll

`Optional` onError: Action<any>

`Optional` onCompleted: Closure