Class InjectableNopeObservable<T, S, G>

RsJX based Observable.

Contains additional Functionalities like:

property with the current value
function to publish values. (wrapper for next)
enables performing a subscription with synced call or a immediate call.

Type Parameters

T
S = T
G = T

Hierarchy

NopeObservable<T, S, G>
- InjectableNopeObservable

Index

Constructors

constructor

new InjectableNopeObservable<T, S, G>(_options?): InjectableNopeObservable<T, S, G>
Type Parameters
- T
- S = T
- G = T
Parameters
- _options: TSubjectOptions = {}
Returns InjectableNopeObservable<T, S, G>
Inherited from NopeObservable.constructor
- Defined in lib/observables/nopeObservable.ts:160

Properties

_subscriptions

_subscriptions: Set<(() => void)> = ...

A Set containing the Subscriptions

_value

_value: T

Accessor to the currently stored value.

disablePublishing

disablePublishing: boolean = false

Flag to Disable Publishing

`Readonly` id

id: string = ...

An id of the Observable. This might be usefull for debugging.

options

options: any = ...

options.

setter

setter: ((value, options?) => {
data: T;
valid: boolean;
}) = null

Type declaration

- (value, options?): {
  data: T;
  valid: boolean;
  }
- Function to specify a Setter
  Parameters
  - value: S
  - Optional options: Partial<IEventAdditionalData>
  Returns {
  data: T;
  valid: boolean;
  }
  - data: T
  - valid: boolean

Accessors

getter

get getter(): ((value) => G)
Returns ((value) => G)
- - (value): G
  - Parameters
    - value: T
    Returns G
Inherited from NopeObservable.getter
- Defined in lib/eventEmitter/nopeEventEmitter.ts:72
set getter(_getter): void
Parameters
- _getter: ((value) => G)
  - - (value): G
    - Parameters
      
      value: T
      
      Returns G
Returns void
Inherited from NopeObservable.getter
- Defined in lib/eventEmitter/nopeEventEmitter.ts:76

hasSubscriptions

get hasSubscriptions(): boolean
Flag, showing if there exists any subscription this particular observer.

Returns boolean
Inherited from NopeObservable.hasSubscriptions
- Defined in lib/eventEmitter/nopeEventEmitter.ts:440

observable

get observable(): BehaviorSubject<IObservableType<G, AD>>
The original Observable. Implemented by an Behaviour Subject. See here: https://www.learnrxjs.io/learn-rxjs/subjects/behaviorsubject for more details.

Returns BehaviorSubject<IObservableType<G, AD>>
Inherited from NopeObservable.observable
- Defined in lib/observables/nopeObservable.ts:43

observerLength

get observerLength(): number
Returns the amout of interessed Subscribers / Observers.

Returns number
Inherited from NopeObservable.observerLength
- Defined in lib/eventEmitter/nopeEventEmitter.ts:444

Methods

dispose

dispose(): void
Function, used to dispose the observable. Every item will be unsubscribed.

Returns void
Inherited from NopeObservable.dispose
- Defined in lib/eventEmitter/nopeEventEmitter.ts:159

emit

emit(value, options?): boolean
Function to update the Content
Parameters
- value: S
  
  The content
- options: Partial<IEventAdditionalData> = {}
Returns boolean
Inherited from NopeObservable.emit
- Defined in lib/eventEmitter/nopeEventEmitter.ts:80

enhancedSubscription

enhancedSubscription<K>(next, options?): Subscription
Create an enhanced Subscription of the Observable. Use the Pipes, to Define what should be subscribed.
Type Parameters
- K
Parameters
- next: ((data) => void)
  
  The Next Function, used to transmit changes
  - - (data): void
    - Parameters
      
      data: K
      
      Returns void
- options: {
      pipe?: IPipe<T | G, K>;
      scope?: {
          [index: string]: any;
      };
  } = {}
  
  The Options, used to determine the Enhancements.
  - Optional pipe?: IPipe<T | G, K>
  - Optional scope?: {
    [index: string]: any;
    }
    - [index: string]: any
Returns Subscription
Inherited from NopeObservable.enhancedSubscription
- Defined in lib/eventEmitter/nopeEventEmitter.ts:294

forcePublish

forcePublish(options?): boolean
Function to Force an Update

Author
M.Karkowski

Returns

Memberof
NopeObservable
Parameters
- options: Partial<IEventAdditionalData> = {}
  
  Options which might be relevant
Returns boolean
Inherited from NopeObservable.forcePublish
- Defined in lib/observables/nopeObservable.ts:126

getContent

getContent(): G
Function to extract the Content. If a Getter is provided, the Getter will be used to Transform the item.

Returns G
Inherited from NopeObservable.getContent
- Defined in lib/observables/nopeObservable.ts:136

once

once(func, options?): INopeObserver
Creates a Subscription for the value of the Observable. After one Update the Value will be deleted
Parameters
- func: IEventCallback<G, IEventAdditionalData>
  
  Function which is called when new Datas are pushed
- Optional options: INopeSubscriptionOptions
  
  Additional Options
Returns INopeObserver
Inherited from NopeObservable.once
- Defined in lib/eventEmitter/nopeEventEmitter.ts:327

setContent

setContent(value, options?): boolean
Function to update the Content
Parameters
- value: S
  
  The content
- options: Partial<IEventAdditionalData> = {}
Returns boolean
Inherited from NopeObservable.setContent
- Defined in lib/observables/nopeObservable.ts:55

subscribe(observer, options?): INopeObserver
A Function to subscribe to updates of the Observable.
Parameters
- observer: INopePartialObserver<G, IEventAdditionalData> | IEventCallback<G, IEventAdditionalData>
  
  The Observer. Could be a Function or a Partial Observer.
- options: INopeSubscriptionOptions = ...
  
  Additional Options.
Returns INopeObserver
Inherited from NopeObservable.subscribe
- Defined in lib/observables/nopeObservable.ts:149

waitFor

waitFor(testCallback?, options?): Promise<G>
Async Function to Wait for an Update
Parameters
- testCallback: IWaitForCallback<G, IEventAdditionalData> = ...
- options: INopeWaitForObservableChangeOptions = ...
  
  Additional Options for the Wait Function.
Returns Promise<G>
Inherited from NopeObservable.waitFor
- Defined in lib/eventEmitter/nopeEventEmitter.ts:351

waitForUpdate

waitForUpdate(options?): Promise<G>
Async Function to Wait for an Update
Parameters
- Optional options: INopeSubscriptionOptions
  
  Additional Options for the Wait Function.
Returns Promise<G>
Inherited from NopeObservable.waitForUpdate
- Defined in lib/eventEmitter/nopeEventEmitter.ts:427

Class InjectableNopeObservable<T, S, G>

Type Parameters

T

S = T

G = T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

S = T

G = T

Parameters

_options: TSubjectOptions = {}

Returns InjectableNopeObservable<T, S, G>

Properties

_subscriptions

_value

disablePublishing

Readonly id

options

setter

Type declaration

Parameters

value: S

Optional options: Partial<IEventAdditionalData>

Returns { data: T; valid: boolean; }

data: T

valid: boolean

Accessors

getter

Returns ((value) => G)

Parameters

value: T

Returns G

Parameters

_getter: ((value) => G)

Parameters

value: T

Returns G

Returns void

hasSubscriptions

Returns boolean

observable

Returns BehaviorSubject<IObservableType<G, AD>>

observerLength

Returns number

Methods

dispose

Returns void

emit

Parameters

value: S

options: Partial<IEventAdditionalData> = {}

Returns boolean

enhancedSubscription

Type Parameters

K

Parameters

next: ((data) => void)

Parameters

data: K

Returns void

options: { pipe?: IPipe<T | G, K>; scope?: { [index: string]: any; }; } = {}

Optional pipe?: IPipe<T | G, K>

Optional scope?: { [index: string]: any; }

[index: string]: any

Returns Subscription

forcePublish

Author

Returns

Memberof

Parameters

options: Partial<IEventAdditionalData> = {}

Returns boolean

`Readonly` id

`Optional` options: Partial<IEventAdditionalData>

Returns {
data: T;
valid: boolean;
}

options: {
pipe?: IPipe<T | G, K>;
scope?: {
[index: string]: any;
};
} = {}

`Optional` pipe?: IPipe<T | G, K>

`Optional` scope?: {
[index: string]: any;
}

`Optional` options: INopeSubscriptionOptions

`Optional` options: INopeSubscriptionOptions