Class Source

constructor

• new Source(): Source

• Returns Source

Staticcreate

StaticfromArray

StaticfromDelay

StaticfromEvent

StaticfromInterval

StaticfromPromise

StaticcreateCold

• createCold<Data>(emitter): Observer<Data>

• Creates a cold observable.

  Type Parameters

  • Data = any

  Parameters

  • emitter: ((next: ((data: Data) => void)) => void | (() => void))

    The emitter function which is called when a subscriber is added. It should return a function that is called when the subscription is unsubscribed, or return undefined if no cleanup is needed.

    • • (next): void | (() => void)

      • Parameters

        • next: ((data: Data) => void)
          • • (data): void

            • Parameters

              • data: Data

              Returns void

        Returns void | (() => void)

  Returns Observer<Data>

  • The created observer.

StaticcreateHot

• createHot<Data>(emitter): Observer<Data>

• Creates a hot observable that emits data as it is received from the given emitter.

  Type Parameters

  • Data = any

    The type of data emitted by the observable.

  Parameters

  • emitter: ((next: ((data: Data) => void)) => void | (() => void))

    The function that receives a callback to emit data. It should return a cleanup function or undefined.

    • • (next): void | (() => void)

      • Parameters

        • next: ((data: Data) => void)
          • • (data): void

            • Parameters

              • data: Data

              Returns void

        Returns void | (() => void)

  Returns Observer<Data>

  The observer that allows subscribing to and unsubscribing from the emitted data.

StaticfromBehaviorSubject

• fromBehaviorSubject<Data>(subject): Observer<Data>

• Creates an observer from a BehaviorSubject.

  Type Parameters

  • Data = any

    The type of data emitted by the BehaviorSubject.

  Parameters

  • subject: TBehaviorSubject<Data>

    The BehaviorSubject to create the observer from.

  Returns Observer<Data>

  The observer created from the BehaviorSubject.

StaticfromSubject

• fromSubject<Data>(subject): Observer<Data>

• Creates an observer from the given subject and returns it.

  Type Parameters

  • Data = any

    The type of data emitted by the observer.

  Parameters

  • subject: TSubject<Data>

    The subject to create the observer from.

  Returns Observer<Data>

  • The observer created from the subject.

StaticfromValue

• fromValue<Data>(data): TObserver<Data>

• Creates a new observer that emits a value from the given data or function.

  Type Parameters

  • Data = any

  Parameters

  • data: Data | (() => Data)

    The data or function to emit from the observer.

  Returns TObserver<Data>

  • The created observer.

Staticjoin

• join<A, B, C, D, E, F, G, H, I, J>(observers, options?): TObserver<[A, B, C, D, E, F, G, H, I, J]>

• Creates a join observer that combines the values emitted by multiple Observers into a single Observable.

  Type Parameters

  • A = never

    The type of the value emitted by the first Observer.
  • B = never

    The type of the value emitted by the second Observer.
  • C = never

    The type of the value emitted by the third Observer.
  • D = never

    The type of the value emitted by the fourth Observer.
  • E = never

    The type of the value emitted by the fifth Observer.
  • F = never

    The type of the value emitted by the sixth Observer.
  • G = never

    The type of the value emitted by the seventh Observer.
  • H = never

    The type of the value emitted by the eighth Observer.
  • I = never

    The type of the value emitted by the ninth Observer.
  • J = never

    The type of the value emitted by the tenth Observer.

  Parameters

  • observers: [TObserver<A>, TObserver<B>?, TObserver<C>?, TObserver<D>?, TObserver<E>?, TObserver<F>?, TObserver<G>?]

    An array of Observers to join.
  • options: {
        buffer?: [A, B?, C?, D?, E?, F?, G?, H?, I?, J?];
        race?: boolean;
    } = {}

    Optional parameters for the join operation, including a buffer and a race flag.

    • Optionalbuffer?: [A, B?, C?, D?, E?, F?, G?, H?, I?, J?]

      An array to store the latest emitted values from each Observer. Defaults to an empty array.

    • Optionalrace?: boolean

      A boolean flag indicating whether to emit the combined values immediately or wait for all Observers to emit a value. Defaults to false.

  Returns TObserver<[A, B, C, D, E, F, G, H, I, J]>

  An Observer that emits an array of values, each value being the latest emitted value from the corresponding Observer.

Staticmerge

• merge<A, B, C, D, E, F, G, H, I, J>(observers): TObserver<
      | A
      | B
      | C
      | D
      | E
      | F
      | G
      | H
      | I
      | J>

• Merges multiple observers into a single observer.

  Type Parameters

  • A = never

    The type of observer A.
  • B = never

    The type of observer B.
  • C = never

    The type of observer C.
  • D = never

    The type of observer D.
  • E = never

    The type of observer E.
  • F = never

    The type of observer F.
  • G = never

    The type of observer G.
  • H = never

    The type of observer H.
  • I = never

    The type of observer I.
  • J = never

    The type of observer J.

  Parameters

  • observers: [TObserver<A>, TObserver<B>?, TObserver<C>?, TObserver<D>?, TObserver<E>?, TObserver<F>?, TObserver<G>?]

    An array of observers to merge.

  Returns TObserver<
      | A
      | B
      | C
      | D
      | E
      | F
      | G
      | H
      | I
      | J>

  • The merged observer.

Staticmulticast

• multicast<Data>(factory): TObserver<Data> & {
      getRef: any;
      isMulticasted: true;
  }

• Creates a multicast observer.

  Type Parameters

  • Data = any

    The type of data being observed.

  Parameters

  • factory: (() => TObserver<Data>)

    A factory function that creates the observer.

    • • (): TObserver<Data>

      • Returns TObserver<Data>

  Returns TObserver<Data> & {
      getRef: any;
      isMulticasted: true;
  }

  • The multicast observer.

Staticpipe

• pipe<Data, Output>(target, emitter): Observer<Output>

• Creates a pipe that connects an observer to a subject and emits output values based on a given emitter function.

  Type Parameters

  • Data = any

    The type of data that will be observed.
  • Output = any

    The type of output that will be emitted.

  Parameters

  • target: TObserver<Data>

    The observer that will receive output values.
  • emitter: ((subject: TSubject<Data>, next: ((output: Output) => void)) => void | (() => void))

    A function that takes a subject and a next function and returns an unsubscribe function.

    • • (subject, next): void | (() => void)

      • Parameters

        • subject: TSubject<Data>
        • next: ((output: Output) => void)
          • • (output): void

            • Parameters

              • output: Output

              Returns void

        Returns void | (() => void)

  Returns Observer<Output>

  The observer that is connected to the subject and emits output values.

Staticunicast

• unicast<Data>(factory): TObserver<Data> & {
      isUnicasted: true;
  }

• Type Parameters

  • Data = any

    The type of data the observer handles.

  Parameters

  • factory: (() => TObserver<Data>)

    A factory function to create the observer.

    • • (): TObserver<Data>

      • Returns TObserver<Data>

  Returns TObserver<Data> & {
      isUnicasted: true;
  }

  • A unicast observer instance.