@ersbeth/picoflow 0.0.1

package/api/doc/picoflow.flowsignal.md

@@ -0,0 +1,111 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowSignal](./picoflow.flowsignal.md)
+
+## FlowSignal class
+
+Represents a reactive signal.
+
+**Signature:**
+
+```typescript
+export declare class FlowSignal 
+```
+
+## Remarks
+
+A FlowSignal allows you to trigger notifications via [FlowSignal.trigger()](./picoflow.flowsignal.trigger.md) and to dispose the signal and all its registered dependencies, listeners, and effects via [FlowSignal.dispose()](./picoflow.flowsignal.dispose.md)<!-- -->.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[disposed](./picoflow.flowsignal.disposed.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Indicates whether the signal has been disposed.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[dispose()](./picoflow.flowsignal.dispose.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Disposes the signal.
+
+
+</td></tr>
+<tr><td>
+
+[trigger()](./picoflow.flowsignal.trigger.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Triggers the signal.
+
+
+</td></tr>
+</tbody></table>

package/api/doc/picoflow.flowsignal.trigger.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowSignal](./picoflow.flowsignal.md) &gt; [trigger](./picoflow.flowsignal.trigger.md)
+
+## FlowSignal.trigger() method
+
+Triggers the signal.
+
+**Signature:**
+
+```typescript
+trigger(): void;
+```
+**Returns:**
+
+void
+
+## Exceptions
+
+Error if the signal is disposed.
+
+## Remarks
+
+This method notifies all registered listeners and causes associated effects to execute.
+

package/api/doc/picoflow.flowstate._constructor_.md

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowState](./picoflow.flowstate.md) &gt; [(constructor)](./picoflow.flowstate._constructor_.md)
+
+## FlowState.(constructor)
+
+Creates a new FlowState with the given initial value.
+
+**Signature:**
+
+```typescript
+constructor(value: T);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+value
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+The initial value for the state.
+
+
+</td></tr>
+</tbody></table>

package/api/doc/picoflow.flowstate.get.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowState](./picoflow.flowstate.md) &gt; [get](./picoflow.flowstate.get.md)
+
+## FlowState.get() method
+
+Retrieves the current state value.
+
+**Signature:**
+
+```typescript
+get(): T;
+```
+**Returns:**
+
+T
+
+The current value of the state.
+
+## Exceptions
+
+Error if the state has been disposed.
+

package/api/doc/picoflow.flowstate.md

@@ -0,0 +1,100 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowState](./picoflow.flowstate.md)
+
+## FlowState class
+
+Represents a reactive state that holds a mutable value.
+
+**Signature:**
+
+```typescript
+export declare class FlowState<T> extends FlowObservable<T> 
+```
+**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T&gt;
+
+## Remarks
+
+FlowState extends FlowObservable to provide a simple reactive state primitive. Use the [FlowState.get()](./picoflow.flowstate.get.md) method to read the current state and [FlowState.set()](./picoflow.flowstate.set.md) to update it. When the state is updated, subscribers are notified automatically.
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(value)](./picoflow.flowstate._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates a new FlowState with the given initial value.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[get()](./picoflow.flowstate.get.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves the current state value.
+
+
+</td></tr>
+<tr><td>
+
+[set(value)](./picoflow.flowstate.set.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Updates the state with a new value.
+
+
+</td></tr>
+</tbody></table>

package/api/doc/picoflow.flowstate.set.md

@@ -0,0 +1,61 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowState](./picoflow.flowstate.md) &gt; [set](./picoflow.flowstate.set.md)
+
+## FlowState.set() method
+
+Updates the state with a new value.
+
+**Signature:**
+
+```typescript
+set(value: T): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+value
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+The new value to set.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+
+## Exceptions
+
+Error if the state has been disposed.
+
+## Remarks
+
+If the new value is identical to the current value, no update or notification occurs. Otherwise, the state is updated and all subscribers are notified.
+

package/api/doc/picoflow.flowstream._constructor_.md

@@ -0,0 +1,65 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowStream](./picoflow.flowstream.md) &gt; [(constructor)](./picoflow.flowstream._constructor_.md)
+
+## FlowStream.(constructor)
+
+Creates a new FlowStream.
+
+**Signature:**
+
+```typescript
+constructor(updater: FlowUpdater<T>, initial: T);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+updater
+
+
+</td><td>
+
+[FlowUpdater](./picoflow.flowupdater.md)<!-- -->&lt;T&gt;
+
+
+</td><td>
+
+A function that receives a setter to update the stream's value. It should return a disposer function that will be called upon disposal.
+
+
+</td></tr>
+<tr><td>
+
+initial
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+The initial value of the stream.
+
+
+</td></tr>
+</tbody></table>

package/api/doc/picoflow.flowstream.dispose.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowStream](./picoflow.flowstream.md) &gt; [dispose](./picoflow.flowstream.dispose.md)
+
+## FlowStream.dispose() method
+
+Disposes the stream, releasing all resources.
+
+**Signature:**
+
+```typescript
+dispose(): void;
+```
+**Returns:**
+
+void
+
+## Remarks
+
+In addition to disposing the underlying observable, this method calls the disposer returned by the updater.
+

package/api/doc/picoflow.flowstream.get.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowStream](./picoflow.flowstream.md) &gt; [get](./picoflow.flowstream.get.md)
+
+## FlowStream.get() method
+
+Retrieves the current value of the stream.
+
+**Signature:**
+
+```typescript
+get(): T;
+```
+**Returns:**
+
+T
+
+The current value.
+
+## Exceptions
+
+Error if the stream is disposed.
+

package/api/doc/picoflow.flowstream.md

@@ -0,0 +1,100 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowStream](./picoflow.flowstream.md)
+
+## FlowStream class
+
+Represents a reactive stream that updates its value based on an updater function.
+
+**Signature:**
+
+```typescript
+export declare class FlowStream<T> extends FlowObservable<T> 
+```
+**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T&gt;
+
+## Remarks
+
+A FlowStream extends FlowObservable and encapsulates a mechanism for updating its value via an external updater function. The updater is invoked during construction with a setter, and it returns a disposer to be called when the stream is disposed.
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(updater, initial)](./picoflow.flowstream._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates a new FlowStream.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[dispose()](./picoflow.flowstream.dispose.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Disposes the stream, releasing all resources.
+
+
+</td></tr>
+<tr><td>
+
+[get()](./picoflow.flowstream.get.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves the current value of the stream.
+
+
+</td></tr>
+</tbody></table>

package/api/doc/picoflow.flowupdater.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowUpdater](./picoflow.flowupdater.md)
+
+## FlowUpdater type
+
+A function that performs updates on a stream.
+
+**Signature:**
+
+```typescript
+export type FlowUpdater<T> = (set: FlowSetter<T>) => FlowDisposer;
+```
+**References:** [FlowSetter](./picoflow.flowsetter.md)<!-- -->, [FlowDisposer](./picoflow.flowdisposer.md)
+
+## Remarks
+
+The updater receives a setter function that can be used to update the stream's value. It should return a disposer function to clean up any resources or subscriptions.
+

package/api/doc/picoflow.flowwatcher.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowWatcher](./picoflow.flowwatcher.md)
+
+## FlowWatcher type
+
+A function for watching a FlowSignal.
+
+**Signature:**
+
+```typescript
+export type FlowWatcher = (signal: FlowSignal) => void;
+```
+**References:** [FlowSignal](./picoflow.flowsignal.md)
+

package/api/doc/picoflow.map.md

@@ -0,0 +1,59 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [map](./picoflow.map.md)
+
+## map() function
+
+Creates a new reactive map state.
+
+**Signature:**
+
+```typescript
+export declare function map<K extends string | number | symbol, V>(initial?: Record<K, V>): FlowMap<K, V>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+initial
+
+
+</td><td>
+
+Record&lt;K, V&gt;
+
+
+</td><td>
+
+_(Optional)_ An optional record of key-value pairs to initialize the map.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[FlowMap](./picoflow.flowmap.md)<!-- -->&lt;K, V&gt;
+
+A new instance of [FlowMap](./picoflow.flowmap.md)<!-- -->.
+
+## Remarks
+
+The initial record is converted to a native Map before being used.
+