@ersbeth/picoflow 0.2.4 → 1.0.0

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

@@ -1,54 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [(constructor)](./picoflow.floweffect._constructor_.md)
-
-## FlowEffect.(constructor)
-
-Creates a new FlowEffect.
-
-**Signature:**
-
-```typescript
-constructor(apply: (get: FlowGetter, watch: FlowWatcher) => void);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-apply
-
-
-</td><td>
-
-(get: [FlowGetter](./picoflow.flowgetter.md)<!-- -->, watch: [FlowWatcher](./picoflow.flowwatcher.md)<!-- -->) =&gt; void
-
-
-</td><td>
-
-A side-effect function that receives a getter and a watcher to access and register dependencies on reactive observables and signals.
-
-
-</td></tr>
-</tbody></table>
-
-## Remarks
-
-The provided function is executed immediately in a tracked mode to collect dependencies. On subsequent executions, it runs in an untracked mode.
-

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

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [dispose](./picoflow.floweffect.dispose.md)
-
-## FlowEffect.dispose() method
-
-Disposes the effect, unregistering all its tracked dependencies.
-
-**Signature:**
-
-```typescript
-dispose(): void;
-```
-**Returns:**
-
-void
-
-## Remarks
-
-Once disposed, the effect must no longer be used. Trying to dispose an effect that is already disposed will throw an error.
-

package/api/doc/picoflow.floweffect.disposed.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [disposed](./picoflow.floweffect.disposed.md)
-
-## FlowEffect.disposed property
-
-Indicates whether this effect has been disposed.
-
-**Signature:**
-
-```typescript
-get disposed(): boolean;
-```

package/api/doc/picoflow.floweffect.md

@@ -1,131 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md)
-
-## FlowEffect class
-
-Represents a reactive effect that executes side-effect functions based on its tracked dependencies.
-
-**Signature:**
-
-```typescript
-export declare class FlowEffect 
-```
-
-## Remarks
-
-The FlowEffect executes an apply function that performs side effects, running initially in a tracked mode to register dependencies and then in an untracked mode to re-execute the effect on updates.
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(apply)](./picoflow.floweffect._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Creates a new FlowEffect.
-
-
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[disposed](./picoflow.floweffect.disposed.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Indicates whether this effect 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.floweffect.dispose.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Disposes the effect, unregistering all its tracked dependencies.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.flowgetter.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowGetter](./picoflow.flowgetter.md)
-
-## FlowGetter type
-
-A function that retrieves the current value from a FlowObservable.
-
-**Signature:**
-
-```typescript
-export type FlowGetter = <T>(observable: FlowObservable<T>) => T;
-```
-**References:** [FlowObservable](./picoflow.flowobservable.md)
-

package/api/doc/picoflow.flowmap._lastdeleted.md

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [$lastDeleted](./picoflow.flowmap._lastdeleted.md)
-
-## FlowMap.$lastDeleted property
-
-A reactive state that holds the most recent key and value that were deleted.
-
-**Signature:**
-
-```typescript
-$lastDeleted: FlowState<{
-        key?: K;
-        value?: V;
-    }>;
-```
-
-## Remarks
-
-When a key is deleted via [FlowMap.delete()](./picoflow.flowmap.delete.md)<!-- -->, this state is updated with the corresponding key and its last known value.
-

package/api/doc/picoflow.flowmap._lastset.md

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [$lastSet](./picoflow.flowmap._lastset.md)
-
-## FlowMap.$lastSet property
-
-A reactive state that holds the most recent key and value that were set.
-
-**Signature:**
-
-```typescript
-$lastSet: FlowState<{
-        key?: K;
-        value?: V;
-    }>;
-```
-
-## Remarks
-
-When a key is set via [FlowMap.setAt()](./picoflow.flowmap.setat.md)<!-- -->, this state is updated with the corresponding key and value.
-

package/api/doc/picoflow.flowmap.delete.md

@@ -1,61 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [delete](./picoflow.flowmap.delete.md)
-
-## FlowMap.delete() method
-
-Deletes the value at the specified key from the underlying map.
-
-**Signature:**
-
-```typescript
-delete(key: K): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-key
-
-
-</td><td>
-
-K
-
-
-</td><td>
-
-The key to delete.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-
-## Exceptions
-
-If the FlowMap instance is disposed.
-
-## Remarks
-
-Removes the key from the internal map, emits the deleted key and its value via [FlowMap.$lastDeleted](./picoflow.flowmap._lastdeleted.md)<!-- -->, and notifies all subscribers of the change.
-

package/api/doc/picoflow.flowmap.md

@@ -1,133 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md)
-
-## FlowMap class
-
-Represents a reactive map of states extending [FlowState](./picoflow.flowstate.md) for a Map of key/value pairs.
-
-**Signature:**
-
-```typescript
-export declare class FlowMap<K, V> extends FlowState<Map<K, V>> 
-```
-**Extends:** [FlowState](./picoflow.flowstate.md)<!-- -->&lt;Map&lt;K, V&gt;&gt;
-
-## Remarks
-
-FlowMap wraps a native Map and provides reactive signals for fine-grained tracking of updates to the map. In addition to the reactive capabilities inherited from FlowState, it exposes two reactive signals:
-
-• $lastSet: Holds the most recent key-value pair that was set. • $lastDeleted: Holds the most recent key-value pair that was deleted.
-
-Use [FlowMap.setAt()](./picoflow.flowmap.setat.md) to add or update a key-value pair and [FlowMap.delete()](./picoflow.flowmap.delete.md) to remove a key.
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[$lastDeleted](./picoflow.flowmap._lastdeleted.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[FlowState](./picoflow.flowstate.md)<!-- -->&lt;{ key?: K; value?: V; }&gt;
-
-
-</td><td>
-
-A reactive state that holds the most recent key and value that were deleted.
-
-
-</td></tr>
-<tr><td>
-
-[$lastSet](./picoflow.flowmap._lastset.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[FlowState](./picoflow.flowstate.md)<!-- -->&lt;{ key?: K; value?: V; }&gt;
-
-
-</td><td>
-
-A reactive state that holds the most recent key and value that were set.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[delete(key)](./picoflow.flowmap.delete.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Deletes the value at the specified key from the underlying map.
-
-
-</td></tr>
-<tr><td>
-
-[setAt(key, value)](./picoflow.flowmap.setat.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Sets a value at the specified key in the underlying map.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.flowmap.setat.md

@@ -1,77 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [setAt](./picoflow.flowmap.setat.md)
-
-## FlowMap.setAt() method
-
-Sets a value at the specified key in the underlying map.
-
-**Signature:**
-
-```typescript
-setAt(key: K, value: V): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-key
-
-
-</td><td>
-
-K
-
-
-</td><td>
-
-The key at which to set the value.
-
-
-</td></tr>
-<tr><td>
-
-value
-
-
-</td><td>
-
-V
-
-
-</td><td>
-
-The value to set.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-
-## Exceptions
-
-If the FlowMap instance is disposed.
-
-## Remarks
-
-Updates the internal map, emits the key-value pair via [FlowMap.$lastSet](./picoflow.flowmap._lastset.md)<!-- -->, and notifies all subscribers of the change.
-

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

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowObservable](./picoflow.flowobservable.md) &gt; [get](./picoflow.flowobservable.get.md)
-
-## FlowObservable.get() method
-
-Retrieves the current value stored in the observable. Subclasses must override this method to provide the current value.
-
-**Signature:**
-
-```typescript
-abstract get(): T;
-```
-**Returns:**
-
-T
-
-The current value of type T.
-

package/api/doc/picoflow.flowobservable.md

@@ -1,68 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowObservable](./picoflow.flowobservable.md)
-
-## FlowObservable class
-
-Represents a reactive observable that holds and tracks a value.
-
-**Signature:**
-
-```typescript
-export declare abstract class FlowObservable<T> extends FlowSignal 
-```
-**Extends:** [FlowSignal](./picoflow.flowsignal.md)
-
-## Remarks
-
-Subclasses must implement the [FlowObservable.get()](./picoflow.flowobservable.get.md) method to return the current value.
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[get()](./picoflow.flowobservable.get.md)
-
-
-</td><td>
-
-`abstract`
-
-
-</td><td>
-
-Retrieves the current value stored in the observable. Subclasses must override this method to provide the current value.
-
-
-</td></tr>
-<tr><td>
-
-[subscribe(listener)](./picoflow.flowobservable.subscribe.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Subscribes a listener function to changes of the observable. The listener is executed immediately with the current value and on subsequent updates.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.flowobservable.subscribe.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowObservable](./picoflow.flowobservable.md) &gt; [subscribe](./picoflow.flowobservable.subscribe.md)
-
-## FlowObservable.subscribe() method
-
-Subscribes a listener function to changes of the observable. The listener is executed immediately with the current value and on subsequent updates.
-
-**Signature:**
-
-```typescript
-subscribe(listener: (value: T) => void): () => void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-listener
-
-
-</td><td>
-
-(value: T) =&gt; void
-
-
-</td><td>
-
-A callback function that receives the new value.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-() =&gt; void
-
-A disposer function to cancel the subscription.
-