@ersbeth/picoflow 0.2.4 → 1.0.0

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

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

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

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

@@ -1,23 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/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 | undefined;
-```
-**Returns:**
-
-T \| undefined
-
-The current value, or undefined if the resource has not been fetched yet.
-
-## Exceptions
-
-Error if the resource is disposed.
-

package/api/doc/picoflow.flowresource.md

@@ -1,100 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/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 | undefined> 
-```
-**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T \| undefined&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)](./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.flowresourceasync._constructor_.md

@@ -1,49 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowResourceAsync](./picoflow.flowresourceasync.md) &gt; [(constructor)](./picoflow.flowresourceasync._constructor_.md)
-
-## FlowResourceAsync.(constructor)
-
-Creates a new FlowResource.
-
-**Signature:**
-
-```typescript
-constructor(fetch: () => Promise<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>
-</tbody></table>

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

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

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

package/api/doc/picoflow.flowresourceasync.md

@@ -1,100 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowResourceAsync](./picoflow.flowresourceasync.md)
-
-## FlowResourceAsync class
-
-Represents a reactive resource that asynchronously fetches its value.
-
-**Signature:**
-
-```typescript
-export declare class FlowResourceAsync<T> extends FlowObservable<Promise<T>> 
-```
-**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;Promise&lt;T&gt;&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)](./picoflow.flowresourceasync._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.flowresourceasync.fetch.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Asynchronously fetches a new value for the resource.
-
-
-</td></tr>
-<tr><td>
-
-[get()](./picoflow.flowresourceasync.get.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Retrieves the current resource value.
-
-
-</td></tr>
-</tbody></table>

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

@@ -1,59 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowSignal](./picoflow.flowsignal.md) &gt; [dispose](./picoflow.flowsignal.dispose.md)
-
-## FlowSignal.dispose() method
-
-Disposes the FlowSignal. Cleans up all registered effects, listeners, and dependencies. Once disposed, further usage of the signal will throw an error.
-
-**Signature:**
-
-```typescript
-dispose(options?: {
-        self: boolean;
-    }): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-options
-
-
-</td><td>
-
-{ self: boolean; }
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-
-## Exceptions
-
-If the FlowSignal is already disposed.
-

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

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowSignal](./picoflow.flowsignal.md) &gt; [disposed](./picoflow.flowsignal.disposed.md)
-
-## FlowSignal.disposed property
-
-Indicates whether the FlowSignal has been disposed.
-
-**Signature:**
-
-```typescript
-get disposed(): boolean;
-```
-
-## Remarks
-
-Once disposed, the signal should not be used.
-

package/api/doc/picoflow.flowsignal.md

@@ -1,112 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowSignal](./picoflow.flowsignal.md)
-
-## FlowSignal class
-
-Represents a reactive signal.
-
-**Signature:**
-
-```typescript
-export declare class FlowSignal implements FlowDisposable 
-```
-**Implements:** [FlowDisposable](./picoflow.flowdisposable.md)
-
-## Remarks
-
-Use FlowSignal to create reactive streams that notify listeners and execute associated effects. Signals can be triggered and disposed. Once disposed, interactions with the signal will throw errors.
-
-## 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 FlowSignal 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(options)](./picoflow.flowsignal.dispose.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Disposes the FlowSignal. Cleans up all registered effects, listeners, and dependencies. Once disposed, further usage of the signal will throw an error.
-
-
-</td></tr>
-<tr><td>
-
-[trigger()](./picoflow.flowsignal.trigger.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Triggers the FlowSignal. Notifies all registered listeners and schedules execution of associated effects.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.flowsignal.trigger.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; [FlowSignal](./picoflow.flowsignal.md) &gt; [trigger](./picoflow.flowsignal.trigger.md)
-
-## FlowSignal.trigger() method
-
-Triggers the FlowSignal. Notifies all registered listeners and schedules execution of associated effects.
-
-**Signature:**
-
-```typescript
-trigger(): void;
-```
-**Returns:**
-
-void
-
-## Exceptions
-
-If the FlowSignal has already been disposed.
-

package/api/doc/picoflow.flowstate.md

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/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 FlowConstant<T> 
-```
-**Extends:** [FlowConstant](./picoflow.flowconstant.md)<!-- -->&lt;T&gt;
-
-## Remarks
-
-FlowState extends FlowConstant, which provides the [FlowConstant.get()](./picoflow.flowconstant.get.md) method to read the current state. Use the [FlowState.set()](./picoflow.flowstate.set.md) method to update the state. When the state is updated, subscribers are notified automatically. This class notifies subscribers only when the value changes.
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[set(value)](./picoflow.flowstate.set.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Updates the state with a new value.
-
-
-</td></tr>
-</tbody></table>