@ersbeth/picoflow 0.0.1 → 0.2.0

package/api/doc/picoflow.flowarray.setitem.md

@@ -0,0 +1,69 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowArray](./picoflow.flowarray.md) &gt; [setItem](./picoflow.flowarray.setitem.md)
+
+## FlowArray.setItem() method
+
+Replaces an item at a specific index.
+
+**Signature:**
+
+```typescript
+setItem(index: number, item: T): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+index
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The index of the item to replace.
+
+
+</td></tr>
+<tr><td>
+
+item
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+The new item.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/api/doc/picoflow.flowarray.shift.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowArray](./picoflow.flowarray.md) &gt; [shift](./picoflow.flowarray.shift.md)
+
+## FlowArray.shift() method
+
+Removes the first item from the array.
+
+**Signature:**
+
+```typescript
+shift(): void;
+```
+**Returns:**
+
+void
+

package/api/doc/picoflow.flowarray.splice.md

@@ -0,0 +1,85 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowArray](./picoflow.flowarray.md) &gt; [splice](./picoflow.flowarray.splice.md)
+
+## FlowArray.splice() method
+
+Changes the content of the array.
+
+**Signature:**
+
+```typescript
+splice(start: number, deleteCount: number, ...newItems: T[]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+start
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The starting index.
+
+
+</td></tr>
+<tr><td>
+
+deleteCount
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+Number of items to remove.
+
+
+</td></tr>
+<tr><td>
+
+newItems
+
+
+</td><td>
+
+T\[\]
+
+
+</td><td>
+
+New items to add.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/api/doc/picoflow.flowarray.unshift.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowArray](./picoflow.flowarray.md) &gt; [unshift](./picoflow.flowarray.unshift.md)
+
+## FlowArray.unshift() method
+
+Inserts an item at the beginning of the array.
+
+**Signature:**
+
+```typescript
+unshift(item: T): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+item
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+The item to insert.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/api/doc/picoflow.flowarrayaction.md

@@ -0,0 +1,37 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowArrayAction](./picoflow.flowarrayaction.md)
+
+## FlowArrayAction type
+
+Represents the actions that can be performed on a FlowArray.
+
+**Signature:**
+
+```typescript
+export type FlowArrayAction<T> = {
+    type: "set";
+    items: T[];
+} | {
+    type: "setItem";
+    index: number;
+    item: T;
+} | {
+    type: "push";
+    item: T;
+} | {
+    type: "pop";
+} | {
+    type: "unshift";
+    item: T;
+} | {
+    type: "shift";
+} | {
+    type: "splice";
+    start: number;
+    deleteCount: number;
+    items: T[];
+} | {
+    type: "clear";
+};
+```

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

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowConstant](./picoflow.flowconstant.md) &gt; [(constructor)](./picoflow.flowconstant._constructor_.md)
+
+## FlowConstant.(constructor)
+
+Creates a new FlowConstant instance.
+
+**Signature:**
+
+```typescript
+constructor(value: T | (() => T));
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+value
+
+
+</td><td>
+
+T \| (() =&gt; T)
+
+
+</td><td>
+
+Either a direct value of type T or a function returning a value of type T for lazy initialization.
+
+
+</td></tr>
+</tbody></table>

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

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowConstant](./picoflow.flowconstant.md) &gt; [get](./picoflow.flowconstant.get.md)
+
+## FlowConstant.get() method
+
+Retrieves the constant value, computing it lazily if needed.
+
+Accessing this method will initialize the value if it has not been computed already. Throws an error if the instance has been disposed or if lazy initialization fails.
+
+**Signature:**
+
+```typescript
+get(): T;
+```
+**Returns:**
+
+T
+
+The cached constant value.
+
+## Exceptions
+
+Error if the constant is disposed or cannot be initialized.
+

package/api/doc/picoflow.flowconstant.md

@@ -0,0 +1,88 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowConstant](./picoflow.flowconstant.md)
+
+## FlowConstant class
+
+Represents a reactive and immutable constant value computed lazily upon first access.
+
+**Signature:**
+
+```typescript
+export declare class FlowConstant<T> extends FlowObservable<T> 
+```
+**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T&gt;
+
+## Remarks
+
+This class extends FlowObservable and supports initializing the constant using either a direct value or a lazy initializer function. Once computed, the value is cached for all subsequent accesses.
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(value)](./picoflow.flowconstant._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates a new FlowConstant instance.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[get()](./picoflow.flowconstant.get.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves the constant value, computing it lazily if needed.
+
+Accessing this method will initialize the value if it has not been computed already. Throws an error if the instance has been disposed or if lazy initialization fails.
+
+
+</td></tr>
+</tbody></table>

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md) &gt; [(constructor)](./picoflow.flowderivation._constructor_.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md) &gt; [(constructor)](./picoflow.flowderivation._constructor_.md)
 
 ## FlowDerivation.(constructor)
 
@@ -42,7 +42,7 @@ compute
 
 </td><td>
 
-A function that computes the derived value. It is provided with a getter and a watcher function to access observables and signals dependencies.
+A function that computes the derived value. It is provided with two parameters: a getter and a watcher that respect dependency tracking.
 
 
 </td></tr>

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md) &gt; [get](./picoflow.flowderivation.get.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md) &gt; [get](./picoflow.flowderivation.get.md)
 
 ## FlowDerivation.get() method
 
@@ -19,5 +19,5 @@ The current computed value.
 
 ## Remarks
 
-This method ensures that the derivation is up-to-date before returning the value.
+This method lazily initializes and updates the derivation if it is marked as dirty. It throws an error if the derivation has been disposed.
 

package/api/doc/picoflow.flowderivation.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md)
 
 ## FlowDerivation class
 
@@ -15,7 +15,7 @@ export declare class FlowDerivation<T> extends FlowObservable<T>
 
 ## Remarks
 
-A FlowDerivation automatically tracks its dependencies and recomputes its value when needed.
+It tracks dependencies automatically and recomputes its value when any dependency changes. Use FlowDerivation to create derived values in a reactive manner. It lazily initializes the computed value, ensuring that computations only occur when necessary.
 
 ## Constructors
 

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

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowDisposable](./picoflow.flowdisposable.md) &gt; [dispose](./picoflow.flowdisposable.dispose.md)
+
+## FlowDisposable.dispose() method
+
+Disposes resources held by this object.
+
+**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)_ Options to specify disposal behavior.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/api/doc/picoflow.flowdisposable.md

@@ -0,0 +1,43 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowDisposable](./picoflow.flowdisposable.md)
+
+## FlowDisposable interface
+
+Represents an object with a disposable lifecycle.
+
+**Signature:**
+
+```typescript
+export interface FlowDisposable 
+```
+
+## Remarks
+
+Objects implementing this interface require explicit resource disposal.
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[dispose(options)](./picoflow.flowdisposable.dispose.md)
+
+
+</td><td>
+
+Disposes resources held by this object.
+
+
+</td></tr>
+</tbody></table>

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [(constructor)](./picoflow.floweffect._constructor_.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [(constructor)](./picoflow.floweffect._constructor_.md)
 
 ## FlowEffect.(constructor)
 
@@ -42,8 +42,13 @@ apply
 
 </td><td>
 
-A function that performs the side effect. It receives a getter and a watcher function to access and register dependencies on reactive observables and signals.
+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,10 +1,10 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [dispose](./picoflow.floweffect.dispose.md)
+[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 dependencies.
+Disposes the effect, unregistering all its tracked dependencies.
 
 **Signature:**
 
@@ -17,5 +17,5 @@ void
 
 ## Remarks
 
-After disposal, the effect should no longer be used. Calling this method on an already disposed effect will throw an error.
+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,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [disposed](./picoflow.floweffect.disposed.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md) &gt; [disposed](./picoflow.floweffect.disposed.md)
 
 ## FlowEffect.disposed property
 

package/api/doc/picoflow.floweffect.md

@@ -1,10 +1,10 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowEffect](./picoflow.floweffect.md)
 
 ## FlowEffect class
 
-Represents a reactive effect that executes a side‐effect function based on its tracked dependencies.
+Represents a reactive effect that executes side-effect functions based on its tracked dependencies.
 
 **Signature:**
 
@@ -14,7 +14,7 @@ export declare class FlowEffect
 
 ## Remarks
 
-A FlowEffect runs an apply function to perform side effects. The apply function is executed in two modes: Initially, in a tracked mode to register dependencies. Subsequently, in an untracked mode to only re-execute the effect .
+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
 
@@ -124,7 +124,7 @@ Description
 
 </td><td>
 
-Disposes the effect, unregistering all its dependencies.
+Disposes the effect, unregistering all its tracked dependencies.
 
 
 </td></tr>

package/api/doc/picoflow.flowgetter.md

@@ -1,10 +1,10 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowGetter](./picoflow.flowgetter.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowGetter](./picoflow.flowgetter.md)
 
 ## FlowGetter type
 
-A function for retrieving the current value from a FlowObservable.
+A function that retrieves the current value from a FlowObservable.
 
 **Signature:**
 

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

@@ -1,6 +1,6 @@
 <!-- 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)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [$lastDeleted](./picoflow.flowmap._lastdeleted.md)
 
 ## FlowMap.$lastDeleted property
 

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

@@ -1,6 +1,6 @@
 <!-- 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)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowMap](./picoflow.flowmap.md) &gt; [$lastSet](./picoflow.flowmap._lastset.md)
 
 ## FlowMap.$lastSet property