Class Observable<T>

Coordinates subscriber actions with publish events

Type Parameters

T

Hierarchy (view full)

BaseObservable<T>
- Observable

Implements

ISyncObservable<T>

Index

Constructors

Properties

CurrentIssue? active subscribers

Methods

Cancel Discontinue Order Publish Reinstate Subscribe

Constructors

constructor

new Observable<T>(): Observable<T>
Type Parameters
- T
Returns Observable<T>
Inherited from BaseObservable.constructor

Properties

`Optional` CurrentIssue

CurrentIssue?: T

`Protected` active

active: boolean = true

`Protected` subscribers

subscribers: Map<string, ((content?) => void)> = ...

Type declaration

- (content?): void
- Parameters
  - Optional content: T
  Returns void

Methods

Cancel

Cancel(subscriptionId): void
Cancel an existing subscription by passing the id returned in the subscribe call
Parameters
- subscriptionId: string
Returns void
Implementation of ISyncObservable.Cancel
Inherited from BaseObservable.Cancel
- Defined in src/Patterns/Observable/BaseObservable.ts:10

Discontinue

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

Returns void
Implementation of ISyncObservable.Discontinue
Inherited from BaseObservable.Discontinue
- Defined in src/Patterns/Observable/BaseObservable.ts:14

Order

Order(func, useCurrentIssue?): void
A single issue subscription. Once the function for an order fires, it is automatically canceled
Parameters
- func: ((content?) => void)
  - - (content?): void
    - Parameters
      Optional content: T
      Returns void
- useCurrentIssue: boolean = true
  Determines if the order can be filled by the current issue
Returns void
Implementation of ISyncObservable.Order
- Defined in src/Patterns/Observable/Observable.ts:18

Publish

Publish(content?): void
Signal a publish event to subscribers with the given content
Parameters
- Optional content: T
Returns void
Implementation of ISyncObservable.Publish
Overrides BaseObservable.Publish
- Defined in src/Patterns/Observable/Observable.ts:33

Reinstate

Reinstate(): void
Resumes calling subscribers on publish events

Returns void
Implementation of ISyncObservable.Reinstate
Inherited from BaseObservable.Reinstate
- Defined in src/Patterns/Observable/BaseObservable.ts:18

Subscribe

Subscribe(func, useCurrentIssue?): string
Specify a function to fire on future publish events | id returned allows caller to cancel subscription
Parameters
- func: ((content?) => void)
  - - (content?): void
    - Parameters
      Optional content: T
      Returns void
- useCurrentIssue: boolean = true
Returns string
Implementation of ISyncObservable.Subscribe
- Defined in src/Patterns/Observable/Observable.ts:7

Generated using TypeDoc