@ersbeth/picoflow 0.2.4 → 1.0.1

package/docs/api/classes/FlowStream.md

@@ -0,0 +1,367 @@
+[@ersbeth/picoflow](/api/index.md) / FlowStream
+
+# Class: FlowStream\<T\>
+
+Defined in: [advanced/stream.ts:97](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/stream.ts#L97)
+
+Represents a reactive stream that updates its value based on an external updater function.
+
+## Remarks
+
+FlowStream extends FlowObservable to bridge external event sources with PicoFlow's reactive
+system. It's designed for integrating with event emitters, WebSocket connections, timers,
+or any push-based data source that sends updates over time.
+
+**How It Works:**
+1. You provide an updater function that receives a setter callback
+2. The updater sets up subscriptions to external events and calls the setter with new values
+3. When the setter is called, the stream notifies all dependent effects and derivations
+4. The updater returns a disposer function for cleanup
+
+**Initial Value:**
+The stream's value is `undefined` until the first time the setter is called. This allows
+you to check if any data has been received yet.
+
+**Change Detection:**
+The stream only notifies subscribers when the new value differs from the current value
+(using strict equality `===`). This prevents unnecessary updates for duplicate values.
+
+**Resource Management:**
+The disposer function returned by your updater is automatically called when the stream
+is disposed. Use it to clean up subscriptions, close connections, or clear timers.
+
+**Use Cases:**
+- WebSocket message streams
+- DOM event listeners
+- setInterval/setTimeout timers
+- Server-sent events (SSE)
+- Observable subscriptions from other libraries
+- Any push-based data source
+
+## Example
+
+```typescript
+// WebSocket stream
+const $messages = stream<string>((set) => {
+  const ws = new WebSocket('ws://example.com');
+  ws.onmessage = (event) => set(event.data);
+  return () => ws.close();
+});
+
+// Timer stream
+const $tick = stream<number>((set) => {
+  let count = 0;
+  const id = setInterval(() => set(count++), 1000);
+  return () => clearInterval(id);
+});
+
+// DOM event stream
+const $clicks = stream<MouseEvent>((set) => {
+  const handler = (e: MouseEvent) => set(e);
+  document.addEventListener('click', handler);
+  return () => document.removeEventListener('click', handler);
+});
+
+// Use in an effect
+effect((t) => {
+  const message = $messages.get(t);
+  if (message) {
+    console.log('Received:', message);
+  }
+});
+```
+
+## Extends
+
+- [`FlowObservable`](/api/classes/FlowObservable.md)\<`T` \| `undefined`\>
+
+## Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The type of the values emitted by the stream. |
+
+## Constructors
+
+### Constructor
+
+```ts
+new FlowStream<T>(updater): FlowStream<T>;
+```
+
+Defined in: [advanced/stream.ts:111](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/stream.ts#L111)
+
+Creates a new FlowStream.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `updater` | [`FlowStreamUpdater`](/api/type-aliases/FlowStreamUpdater.md)\<`T`\> | A function that receives a setter callback and returns a disposer. The setter should be called whenever new data is available. The disposer will be invoked when the stream is disposed to clean up resources. |
+
+#### Returns
+
+`FlowStream`\<`T`\>
+
+#### Remarks
+
+The updater is invoked immediately during construction. Make sure to return a proper
+cleanup function to avoid resource leaks.
+
+#### Overrides
+
+[`FlowObservable`](/api/classes/FlowObservable.md).[`constructor`](/api/classes/FlowObservable.md#constructor)
+
+## Accessors
+
+### disposed
+
+#### Get Signature
+
+```ts
+get disposed(): boolean;
+```
+
+Defined in: [basic/signal.ts:97](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/signal.ts#L97)
+
+Indicates whether the FlowSignal has been disposed.
+
+##### Remarks
+
+Once disposed, the signal should not be used.
+
+##### Returns
+
+`boolean`
+
+#### Inherited from
+
+[`FlowObservable`](/api/classes/FlowObservable.md).[`disposed`](/api/classes/FlowObservable.md#disposed)
+
+## Methods
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [advanced/stream.ts:134](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/stream.ts#L134)
+
+Disposes the stream, releasing all resources.
+
+#### Returns
+
+`void`
+
+#### Remarks
+
+In addition to disposing the underlying observable, this method calls the disposer
+returned by the updater.
+
+#### Overrides
+
+[`FlowObservable`](/api/classes/FlowObservable.md).[`dispose`](/api/classes/FlowObservable.md#dispose)
+
+***
+
+### get()
+
+```ts
+get(context): T | undefined;
+```
+
+Defined in: [basic/observable.ts:47](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/observable.ts#L47)
+
+Gets the current value with optional dependency tracking.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `context` | [`TrackingContext`](/api/classes/TrackingContext.md) \| `null` | The tracking context for reactive tracking, or null for untracked access. When a context is provided, this observable is registered as a dependency. When null, the value is read without any tracking. |
+
+#### Returns
+
+`T` \| `undefined`
+
+The current value of type T.
+
+#### Remarks
+
+Use `get(t)` within effects and derivations to create reactive dependencies.
+Use `get(null)` when you need to read a value without tracking (though `pick()` is more idiomatic).
+
+#### Example
+
+```typescript
+effect((t) => {
+  const tracked = $state.get(t);     // Dependency registered
+  const untracked = $other.get(null); // No dependency
+});
+```
+
+#### Inherited from
+
+[`FlowObservable`](/api/classes/FlowObservable.md).[`get`](/api/classes/FlowObservable.md#get)
+
+***
+
+### pick()
+
+```ts
+pick(): T | undefined;
+```
+
+Defined in: [basic/observable.ts:82](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/observable.ts#L82)
+
+Gets the current value without any dependency tracking.
+
+#### Returns
+
+`T` \| `undefined`
+
+The current value of type T.
+
+#### Remarks
+
+This method is equivalent to calling `get(null)` but provides a more semantic and readable API.
+Use `pick()` when you want to read a snapshot of the current value without creating a reactive
+dependency. This is useful for:
+- Reading initial values
+- Accessing configuration that shouldn't trigger updates
+- Mixing tracked and untracked reads in the same effect
+
+#### Example
+
+```typescript
+// Read a snapshot outside reactive context
+const currentValue = $state.pick();
+
+// Mix tracked and untracked reads
+effect((t) => {
+  const tracked = $reactive.get(t);    // Triggers re-runs
+  const snapshot = $config.pick();     // Doesn't trigger re-runs
+  processData(tracked, snapshot);
+});
+```
+
+#### Inherited from
+
+[`FlowObservable`](/api/classes/FlowObservable.md).[`pick`](/api/classes/FlowObservable.md#pick)
+
+***
+
+### subscribe()
+
+```ts
+subscribe(listener): () => void;
+```
+
+Defined in: [basic/observable.ts:103](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/observable.ts#L103)
+
+Subscribes a listener function to changes of the observable.
+The listener is executed immediately with the current value and on subsequent updates.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `listener` | (`value`) => `void` | A callback function that receives the new value. |
+
+#### Returns
+
+A disposer function to cancel the subscription.
+
+```ts
+(): void;
+```
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+[`FlowObservable`](/api/classes/FlowObservable.md).[`subscribe`](/api/classes/FlowObservable.md#subscribe)
+
+***
+
+### trigger()
+
+```ts
+trigger(): void;
+```
+
+Defined in: [basic/signal.ts:19](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/signal.ts#L19)
+
+Triggers the FlowSignal.
+Notifies all registered listeners and schedules execution of associated effects.
+
+#### Returns
+
+`void`
+
+#### Throws
+
+If the FlowSignal has already been disposed.
+
+#### Inherited from
+
+[`FlowObservable`](/api/classes/FlowObservable.md).[`trigger`](/api/classes/FlowObservable.md#trigger)
+
+***
+
+### watch()
+
+```ts
+watch(context): void;
+```
+
+Defined in: [basic/signal.ts:57](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/signal.ts#L57)
+
+Watches the signal, registering it as a dependency in the tracking context.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `context` | [`TrackingContext`](/api/classes/TrackingContext.md) | The tracking context in which to register this signal as a dependency. |
+
+#### Returns
+
+`void`
+
+#### Remarks
+
+Use `watch()` when you want to track a signal without reading its value (signals don't
+have values to read). This is useful for triggering effects based on signal events
+without needing associated data.
+
+When the signal is triggered via `trigger()`, any effects or derivations that have
+watched this signal will automatically re-execute.
+
+This method must be called within an effect or derivation context where a TrackingContext
+is available. For observables (which hold values), use `.get(t)` instead, which both
+reads the value and watches for changes.
+
+#### Throws
+
+Error if the signal has been disposed.
+
+#### Example
+
+```typescript
+const $signal = signal();
+
+effect((t) => {
+  $signal.watch(t);  // Track the signal
+  console.log('Signal triggered!');
+});
+
+$signal.trigger(); // Logs: "Signal triggered!"
+```
+
+#### Inherited from
+
+[`FlowObservable`](/api/classes/FlowObservable.md).[`watch`](/api/classes/FlowObservable.md#watch)