Class Observable<T>

constructor

• new Observable<T>(
      onObserverAdded?: (observer: Observer<T>) => void,
      notifyIfTriggered?: boolean,
  ): Observable<T>

  Creates a new observable

  Type Parameters

  • T

  Parameters

  • OptionalonObserverAdded: (observer: Observer<T>) => void

    defines a callback to call when a new observer is added

  • notifyIfTriggered: boolean = false

    If set to true the observable will notify when an observer was added if the observable was already triggered.

  Returns Observable<T>

Optional_coroutineScheduler

Optional_coroutineSchedulerDispose

notifyIfTriggered

observers

• get observers(): Observer<T>[]

  Gets the list of observers Note that observers that were recently deleted may still be present in the list because they are only really deleted on the next javascript tick!

  Returns Observer<T>[]

add

• add(
      callback?: null,
      mask?: number,
      insertFirst?: boolean,
      scope?: any,
      unregisterOnFirstCall?: boolean,
  ): null

  Create a new Observer with the specified callback

  Parameters

  • Optionalcallback: null

    the callback that will be executed for that Observer

  • Optionalmask: number

    the mask used to filter observers

  • OptionalinsertFirst: boolean

    if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.

  • Optionalscope: any

    optional scope for the callback to be called from

  • OptionalunregisterOnFirstCall: boolean

    defines if the observer as to be unregistered after the next notification

  Returns null

  the new observer created for the callback

• add(
      callback: (eventData: T, eventState: EventState) => void,
      mask?: number,
      insertFirst?: boolean,
      scope?: any,
      unregisterOnFirstCall?: boolean,
  ): Observer<T>

  Create a new Observer with the specified callback

  Parameters

  • callback: (eventData: T, eventState: EventState) => void

    the callback that will be executed for that Observer

  • Optionalmask: number

    the mask used to filter observers

  • OptionalinsertFirst: boolean

    if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.

  • Optionalscope: any

    optional scope for the callback to be called from

  • OptionalunregisterOnFirstCall: boolean

    defines if the observer as to be unregistered after the next notification

  Returns Observer<T>

  the new observer created for the callback

• add(
      callback?: ((eventData: T, eventState: EventState) => void) | null,
      mask?: number,
      insertFirst?: boolean,
      scope?: any,
      unregisterOnFirstCall?: boolean,
  ): Nullable<Observer<T>>

  Create a new Observer with the specified callback

  Parameters

  • Optionalcallback: ((eventData: T, eventState: EventState) => void) | null

    the callback that will be executed for that Observer

  • Optionalmask: number

    the mask used to filter observers

  • OptionalinsertFirst: boolean

    if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.

  • Optionalscope: any

    optional scope for the callback to be called from

  • OptionalunregisterOnFirstCall: boolean

    defines if the observer as to be unregistered after the next notification

  Returns Nullable<Observer<T>>

  the new observer created for the callback

addOnce

• addOnce(callback?: null): null

  Create a new Observer with the specified callback and unregisters after the next notification

  Parameters

  • Optionalcallback: null

    the callback that will be executed for that Observer

  Returns null

  the new observer created for the callback

• addOnce(callback: (eventData: T, eventState: EventState) => void): Observer<T>

  Create a new Observer with the specified callback and unregisters after the next notification

  Parameters

  • callback: (eventData: T, eventState: EventState) => void

    the callback that will be executed for that Observer

  Returns Observer<T>

  the new observer created for the callback

• addOnce(
      callback?: ((eventData: T, eventState: EventState) => void) | null,
  ): Nullable<Observer<T>>

  Create a new Observer with the specified callback and unregisters after the next notification

  Parameters

  • Optionalcallback: ((eventData: T, eventState: EventState) => void) | null

    the callback that will be executed for that Observer

  Returns Nullable<Observer<T>>

  the new observer created for the callback

cancelAllCoroutines

• cancelAllCoroutines(): void

  Cancels all coroutines currently running on this observable

  Returns void

cleanLastNotifiedState

• cleanLastNotifiedState(): void

  Clean the last notified state - both the internal last value and the has-notified flag

  Returns void

clear

• clear(): void

  Clear the list of observers

  Returns void

clone

• clone(): Observable<T>

  Clone the current observable

  Returns Observable<T>

  a new observable

hasObservers

• hasObservers(): boolean

  Gets a boolean indicating if the observable has at least one observer

  Returns boolean

  true is the Observable has at least one Observer registered

hasSpecificMask

• hasSpecificMask(mask?: number): boolean

  Does this observable handles observer registered with a given mask

  Parameters

  • mask: number = -1

    defines the mask to be tested

  Returns boolean

  whether or not one observer registered with the given mask is handled

makeObserverBottomPriority

• makeObserverBottomPriority(observer: Observer<T>): void

  Moves the observable to the bottom of the observer list making it get called last when notified

  Parameters

  • observer: Observer<T>

    the observer to move

  Returns void

makeObserverTopPriority

• makeObserverTopPriority(observer: Observer<T>): void

  Moves the observable to the top of the observer list making it get called first when notified

  Parameters

  • observer: Observer<T>

    the observer to move

  Returns void

notifyObserver

• notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void

  Notify a specific observer

  Parameters

  • observer: Observer<T>

    defines the observer to notify

  • eventData: T

    defines the data to be sent to each callback

  • mask: number = -1

    is used to filter observers defaults to -1

  Returns void

notifyObservers

• notifyObservers(
      eventData: T,
      mask?: number,
      target?: any,
      currentTarget?: any,
      userInfo?: any,
  ): boolean

  Notify all Observers by calling their respective callback with the given data Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute

  Parameters

  • eventData: T

    defines the data to send to all observers

  • mask: number = -1

    defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)

  • Optionaltarget: any

    defines the original target of the state

  • OptionalcurrentTarget: any

    defines the current target of the state

  • OptionaluserInfo: any

    defines any user info to send to observers

  Returns boolean

  false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)

notifyObserversWithPromise

• notifyObserversWithPromise(
      eventData: T,
      mask?: number,
      target?: any,
      currentTarget?: any,
      userInfo?: any,
  ): Promise<T>

  Calling this will execute each callback, expecting it to be a promise or return a value. If at any point in the chain one function fails, the promise will fail and the execution will not continue. This is useful when a chain of events (sometimes async events) is needed to initialize a certain object and it is crucial that all callbacks will be executed. The order of the callbacks is kept, callbacks are not executed parallel.

  Parameters

  • eventData: T

    The data to be sent to each callback

  • Optionalmask: number

    is used to filter observers defaults to -1

  • Optionaltarget: any

    defines the callback target (see EventState)

  • OptionalcurrentTarget: any

    defines he current object in the bubbling phase

  • OptionaluserInfo: any

    defines any user info to send to observers

  Returns Promise<T>

  will return a Promise than resolves when all callbacks executed successfully.

remove

• remove(observer: Nullable<Observer<T>>): boolean

  Remove an Observer from the Observable object

  Parameters

  • observer: Nullable<Observer<T>>

    the instance of the Observer to remove

  Returns boolean

  false if it doesn't belong to this Observable

removeCallback

• removeCallback(
      callback: (eventData: T, eventState: EventState) => void,
      scope?: any,
  ): boolean

  Remove a callback from the Observable object

  Parameters

  • callback: (eventData: T, eventState: EventState) => void

    the callback to remove

  • Optionalscope: any

    optional scope. If used only the callbacks with this scope will be removed

  Returns boolean

  false if it doesn't belong to this Observable

runCoroutineAsync

• runCoroutineAsync(coroutine: AsyncCoroutine<void>): Promise<void>

  Runs a coroutine asynchronously on this observable

  Parameters

  • coroutine: AsyncCoroutine<void>

    the iterator resulting from having started the coroutine

  Returns Promise<void>

  a promise which will be resolved when the coroutine finishes or rejected if the coroutine is cancelled

StaticFromPromise

• FromPromise<T, E = Error>(
      promise: Promise<T>,
      onErrorObservable?: Observable<E>,
  ): Observable<T>

  Create an observable from a Promise.

  Type Parameters

  • T
  • E = Error

  Parameters

  • promise: Promise<T>

    a promise to observe for fulfillment.

  • OptionalonErrorObservable: Observable<E>

    an observable to notify if a promise was rejected.

  Returns Observable<T>

  the new Observable