Interface IObservable<T>

Coordinates subscriber actions with publish events

interface IObservable<T> {
    Cancel(subscriptionId): void;
    Discontinue(): void;
    Publish(content?): void;
    Reinstate(): void;
}

Type Parameters

T

Hierarchy (view full)

IObservable
- IAsyncObservable
- ISyncObservable

Implemented by

BaseObservable

Index

Methods

Cancel Discontinue Publish Reinstate

Methods

Cancel

Cancel(subscriptionId): void
Cancel an existing subscription by passing the id returned in the subscribe call
Parameters
- subscriptionId: string
Returns void
- Defined in src/Patterns/Observable/IObservable.ts:16

Discontinue

Discontinue(): void
Prevents future publish events from calling subscribers

Returns void
- Defined in src/Patterns/Observable/IObservable.ts:21

Publish

Publish(content?): void
Signal a publish event to subscribers with the given content
Parameters
- Optional content: T
Returns void
- Defined in src/Patterns/Observable/IObservable.ts:9

Reinstate

Reinstate(): void
Resumes calling subscribers on publish events

Returns void
- Defined in src/Patterns/Observable/IObservable.ts:26

Generated using TypeDoc