@ersbeth/picoflow 0.2.4 → 1.0.1

package/api/doc/picoflow.derivation.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; [derivation](./picoflow.derivation.md)
-
-## derivation() function
-
-Creates a new reactive derivation whose value is computed based on other reactive signals.
-
-**Signature:**
-
-```typescript
-export declare function derivation<T>(fn: (get: FlowGetter, watch: FlowWatcher) => T): FlowDerivation<T>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-fn
-
-
-</td><td>
-
-(get: [FlowGetter](./picoflow.flowgetter.md)<!-- -->, watch: [FlowWatcher](./picoflow.flowwatcher.md)<!-- -->) =&gt; T
-
-
-</td><td>
-
-A function that computes the derived value. It receives a getter and a watcher function to access and register dependencies.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[FlowDerivation](./picoflow.flowderivation.md)<!-- -->&lt;T&gt;
-
-A new instance of [FlowDerivation](./picoflow.flowderivation.md)<!-- -->.
-

package/api/doc/picoflow.effect.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; [effect](./picoflow.effect.md)
-
-## effect() function
-
-Creates a new reactive effect that executes a side-effect function based on its dependencies.
-
-**Signature:**
-
-```typescript
-export declare function effect(fn: (get: FlowGetter, watch: FlowWatcher) => void): FlowEffect;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-fn
-
-
-</td><td>
-
-(get: [FlowGetter](./picoflow.flowgetter.md)<!-- -->, watch: [FlowWatcher](./picoflow.flowwatcher.md)<!-- -->) =&gt; void
-
-
-</td><td>
-
-A function that performs side effects. It receives a getter and a watcher function for tracking reactive dependencies.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[FlowEffect](./picoflow.floweffect.md)
-
-A new instance of [FlowEffect](./picoflow.floweffect.md)<!-- -->.
-

package/api/doc/picoflow.flowarray._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; [FlowArray](./picoflow.flowarray.md) &gt; [(constructor)](./picoflow.flowarray._constructor_.md)
-
-## FlowArray.(constructor)
-
-Creates an instance of FlowArray.
-
-**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>
-
-_(Optional)_ Initial array value.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.flowarray._lastaction.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; [FlowArray](./picoflow.flowarray.md) &gt; [$lastAction](./picoflow.flowarray._lastaction.md)
-
-## FlowArray.$lastAction property
-
-Last action performed on the FlowArray.
-
-**Signature:**
-
-```typescript
-$lastAction: FlowState<FlowArrayAction<T>>;
-```

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

@@ -1,17 +0,0 @@
-<!-- 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; [clear](./picoflow.flowarray.clear.md)
-
-## FlowArray.clear() method
-
-Clears all items from the array.
-
-**Signature:**
-
-```typescript
-clear(): void;
-```
-**Returns:**
-
-void
-

package/api/doc/picoflow.flowarray.dispose.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; [FlowArray](./picoflow.flowarray.md) &gt; [dispose](./picoflow.flowarray.dispose.md)
-
-## FlowArray.dispose() method
-
-Disposes the FlowArray and its items.
-
-**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)_ Disposal options.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

package/api/doc/picoflow.flowarray.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; [FlowArray](./picoflow.flowarray.md) &gt; [get](./picoflow.flowarray.get.md)
-
-## FlowArray.get() method
-
-Returns a copy of the internal array.
-
-**Signature:**
-
-```typescript
-get(): T[];
-```
-**Returns:**
-
-T\[\]
-
-A copy of the array.
-

package/api/doc/picoflow.flowarray.length.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; [FlowArray](./picoflow.flowarray.md) &gt; [length](./picoflow.flowarray.length.md)
-
-## FlowArray.length property
-
-Gets the current length of the array.
-
-**Signature:**
-
-```typescript
-get length(): number;
-```

package/api/doc/picoflow.flowarray.md

@@ -1,273 +0,0 @@
-<!-- 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)
-
-## FlowArray class
-
-Represents a reactive array.
-
-**Signature:**
-
-```typescript
-export declare class FlowArray<T> extends FlowObservable<T[]> 
-```
-**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T\[\]&gt;
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(value)](./picoflow.flowarray._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Creates an instance of FlowArray.
-
-
-</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>
-
-[$lastAction](./picoflow.flowarray._lastaction.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[FlowState](./picoflow.flowstate.md)<!-- -->&lt;[FlowArrayAction](./picoflow.flowarrayaction.md)<!-- -->&lt;T&gt;&gt;
-
-
-</td><td>
-
-Last action performed on the FlowArray.
-
-
-</td></tr>
-<tr><td>
-
-[length](./picoflow.flowarray.length.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-Gets the current length of the array.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[clear()](./picoflow.flowarray.clear.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Clears all items from the array.
-
-
-</td></tr>
-<tr><td>
-
-[dispose(options)](./picoflow.flowarray.dispose.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Disposes the FlowArray and its items.
-
-
-</td></tr>
-<tr><td>
-
-[get()](./picoflow.flowarray.get.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Returns a copy of the internal array.
-
-
-</td></tr>
-<tr><td>
-
-[pop()](./picoflow.flowarray.pop.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Removes the last item from the array.
-
-
-</td></tr>
-<tr><td>
-
-[push(item)](./picoflow.flowarray.push.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Appends an item to the end of the array.
-
-
-</td></tr>
-<tr><td>
-
-[set(items)](./picoflow.flowarray.set.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Replaces the entire array with new items.
-
-
-</td></tr>
-<tr><td>
-
-[setItem(index, item)](./picoflow.flowarray.setitem.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Replaces an item at a specific index.
-
-
-</td></tr>
-<tr><td>
-
-[shift()](./picoflow.flowarray.shift.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Removes the first item from the array.
-
-
-</td></tr>
-<tr><td>
-
-[splice(start, deleteCount, newItems)](./picoflow.flowarray.splice.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Changes the content of the array.
-
-
-</td></tr>
-<tr><td>
-
-[unshift(item)](./picoflow.flowarray.unshift.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Inserts an item at the beginning of the array.
-
-
-</td></tr>
-</tbody></table>

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

@@ -1,17 +0,0 @@
-<!-- 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; [pop](./picoflow.flowarray.pop.md)
-
-## FlowArray.pop() method
-
-Removes the last item from the array.
-
-**Signature:**
-
-```typescript
-pop(): void;
-```
-**Returns:**
-
-void
-

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

@@ -1,53 +0,0 @@
-<!-- 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; [push](./picoflow.flowarray.push.md)
-
-## FlowArray.push() method
-
-Appends an item to the end of the array.
-
-**Signature:**
-
-```typescript
-push(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 append.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

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

@@ -1,53 +0,0 @@
-<!-- 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; [set](./picoflow.flowarray.set.md)
-
-## FlowArray.set() method
-
-Replaces the entire array with new items.
-
-**Signature:**
-
-```typescript
-set(items: T[]): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-items
-
-
-</td><td>
-
-T\[\]
-
-
-</td><td>
-
-The new array of items.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-