@shtse8/fluxus v1.0.0

---

@shtse8/fluxus / src / streamProvider

Function: streamProvider()

streamProvider<T>(create, options?): StreamProviderInstance<T>

Defined in: src/providers/streamProvider.ts:119

Creates a StreamProvider.

A StreamProvider manages the state derived from an asynchronous stream (like an RxJS Observable, WebSocket stream, etc.). It subscribes to the stream and exposes the latest emitted value as an AsyncValue<T>.

Type Parameters

T

T

The type of data the stream emits.

Parameters

create

(read) => Subscribable<T>

A function that takes a ScopeReader and returns a Subscribable<T> (an object with a subscribe method).

options?

ProviderOptions

Returns

StreamProviderInstance<T>

An StreamProviderInstance.

Example

// Example with a conceptual timer stream
const timerProvider = streamProvider<number>((read) => {
  let count = 0;
  const intervalId = setInterval(() => {
    // How to push value to subscribers? Need an Observable-like object.
    // This example needs refinement based on actual stream implementation.
  }, 1000);

  read.onDispose(() => clearInterval(intervalId));

  // Return an object conforming to Subscribable<number>
  return {
     subscribe: (observer) => {
         // Simplified: Need proper implementation to emit count
         observer.next?.(count); // Emit initial value?
         // ... logic to emit subsequent values ...
         return { unsubscribe: () => clearInterval(intervalId) };
     }
  };
});