@ersbeth/picoflow 0.0.1

package/api/doc/picoflow.flowmap._lastdeleted.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; [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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [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

@@ -0,0 +1,57 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [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
+
+## Remarks
+
+This method removes the key from the internal map, emits the deleted key and its corresponding value via [FlowMap.$lastDeleted](./picoflow.flowmap._lastdeleted.md)<!-- -->, and notifies subscribers of the change.
+

package/api/doc/picoflow.flowmap.md

@@ -0,0 +1,135 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md)
+
+## FlowMap class
+
+Represents a reactive map of states that extends [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 public signals:
+
+\*\*$lastSet\*\*: A FlowState that holds the most recent key-value pair that was set.
+
+\*\*$lastDeleted\*\*: A FlowState that holds the most recent key-value pair that was deleted.
+
+Use [FlowMap.setAt()](./picoflow.flowmap.setat.md) to set 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

@@ -0,0 +1,73 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [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
+
+## Remarks
+
+This method updates the internal map with the given key and value, emits the new key-value pair via [FlowMap.$lastSet](./picoflow.flowmap._lastset.md)<!-- -->, and notifies subscribers of the change.
+

package/api/doc/picoflow.flowobservable.get.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; [FlowObservable](./picoflow.flowobservable.md) &gt; [get](./picoflow.flowobservable.get.md)
+
+## FlowObservable.get() method
+
+Retrieves the current value of the observable.
+
+**Signature:**
+
+```typescript
+abstract get(): T;
+```
+**Returns:**
+
+T
+
+The current value.
+

package/api/doc/picoflow.flowobservable.md

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowObservable](./picoflow.flowobservable.md)
+
+## FlowObservable class
+
+Represents a reactive observable that carries a value.
+
+**Signature:**
+
+```typescript
+export declare abstract class FlowObservable<T> extends FlowSignal 
+```
+**Extends:** [FlowSignal](./picoflow.flowsignal.md)
+
+## Remarks
+
+A FlowObservable extends the basic FlowSignal to store a value. Subclasses must implement the abstract [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 of the observable.
+
+
+</td></tr>
+</tbody></table>

package/api/doc/picoflow.flowresource._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; [FlowResource](./picoflow.flowresource.md) &gt; [(constructor)](./picoflow.flowresource._constructor_.md)
+
+## FlowResource.(constructor)
+
+Creates a new FlowResource.
+
+**Signature:**
+
+```typescript
+constructor(fetch: () => Promise<T>, initial: T);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fetch
+
+
+</td><td>
+
+() =&gt; Promise&lt;T&gt;
+
+
+</td><td>
+
+An asynchronous function that retrieves the resource's value.
+
+
+</td></tr>
+<tr><td>
+
+initial
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+The initial value of the resource.
+
+
+</td></tr>
+</tbody></table>

package/api/doc/picoflow.flowresource.fetch.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowResource](./picoflow.flowresource.md) &gt; [fetch](./picoflow.flowresource.fetch.md)
+
+## FlowResource.fetch() method
+
+Asynchronously fetches a new value for the resource.
+
+**Signature:**
+
+```typescript
+fetch(): Promise<void>;
+```
+**Returns:**
+
+Promise&lt;void&gt;
+
+A Promise that resolves when the fetch operation is complete.
+
+## Exceptions
+
+Error if the resource is disposed.
+
+## Remarks
+
+Executes the internal fetch function. If the fetched value differs from the current one, updates the resource's value and notifies subscribers.
+

package/api/doc/picoflow.flowresource.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; [FlowResource](./picoflow.flowresource.md) &gt; [get](./picoflow.flowresource.get.md)
+
+## FlowResource.get() method
+
+Retrieves the current resource value.
+
+**Signature:**
+
+```typescript
+get(): T;
+```
+**Returns:**
+
+T
+
+The current value.
+
+## Exceptions
+
+Error if the resource is disposed.
+

package/api/doc/picoflow.flowresource.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; [FlowResource](./picoflow.flowresource.md)
+
+## FlowResource class
+
+Represents a reactive resource that asynchronously fetches its value.
+
+**Signature:**
+
+```typescript
+export declare class FlowResource<T> extends FlowObservable<T> 
+```
+**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T&gt;
+
+## Remarks
+
+A FlowResource extends FlowObservable and encapsulates an asynchronous fetch function. It is used to retrieve and update its value asynchronously. When the fetch is executed, if the new value differs from the current value, the resource is updated and its subscribers are notified.
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(fetch, initial)](./picoflow.flowresource._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates a new FlowResource.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[fetch()](./picoflow.flowresource.fetch.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Asynchronously fetches a new value for the resource.
+
+
+</td></tr>
+<tr><td>
+
+[get()](./picoflow.flowresource.get.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves the current resource value.
+
+
+</td></tr>
+</tbody></table>

package/api/doc/picoflow.flowsetter.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowSetter](./picoflow.flowsetter.md)
+
+## FlowSetter type
+
+A function that sets a new value.
+
+**Signature:**
+
+```typescript
+export type FlowSetter<T> = (value: T) => void;
+```

package/api/doc/picoflow.flowsignal.dispose.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; [dispose](./picoflow.flowsignal.dispose.md)
+
+## FlowSignal.dispose() method
+
+Disposes the signal.
+
+**Signature:**
+
+```typescript
+dispose(): void;
+```
+**Returns:**
+
+void
+
+## Exceptions
+
+Error if the signal is already disposed.
+
+## Remarks
+
+Disposing a signal will dispose all registered effects and listeners, and unregister all dependencies. Once disposed, any further calls to the signal will throw an error.
+

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

@@ -0,0 +1,18 @@
+<!-- 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; [disposed](./picoflow.flowsignal.disposed.md)
+
+## FlowSignal.disposed property
+
+Indicates whether the signal has been disposed.
+
+**Signature:**
+
+```typescript
+get disposed(): boolean;
+```
+
+## Remarks
+
+Once disposed, the signal should not be used.
+