@ersbeth/picoflow 0.2.4 → 1.0.0

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

@@ -1,69 +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; [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

@@ -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; [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

@@ -1,85 +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; [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

@@ -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; [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

@@ -1,37 +0,0 @@
-<!-- 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

@@ -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; [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

@@ -1,25 +0,0 @@
-<!-- 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

@@ -1,88 +0,0 @@
-<!-- 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,49 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md) &gt; [(constructor)](./picoflow.flowderivation._constructor_.md)
-
-## FlowDerivation.(constructor)
-
-Creates a new FlowDerivation.
-
-**Signature:**
-
-```typescript
-constructor(compute: (get: FlowGetter, watch: FlowWatcher) => T);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-compute
-
-
-</td><td>
-
-(get: [FlowGetter](./picoflow.flowgetter.md)<!-- -->, watch: [FlowWatcher](./picoflow.flowwatcher.md)<!-- -->) =&gt; T
-
-
-</td><td>
-
-A function that computes the derived value. It is provided with two parameters: a getter and a watcher that respect dependency tracking.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.flowderivation.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; [FlowDerivation](./picoflow.flowderivation.md) &gt; [get](./picoflow.flowderivation.get.md)
-
-## FlowDerivation.get() method
-
-Gets the current derived value.
-
-**Signature:**
-
-```typescript
-get(): T;
-```
-**Returns:**
-
-T
-
-The current computed value.
-
-## Remarks
-
-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,86 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowDerivation](./picoflow.flowderivation.md)
-
-## FlowDerivation class
-
-Represents a reactive derivation whose value is computed based on other reactive signals.
-
-**Signature:**
-
-```typescript
-export declare class FlowDerivation<T> extends FlowObservable<T> 
-```
-**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T&gt;
-
-## Remarks
-
-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
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(compute)](./picoflow.flowderivation._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Creates a new FlowDerivation.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[get()](./picoflow.flowderivation.get.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Gets the current derived value.
-
-
-</td></tr>
-</tbody></table>

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

@@ -1,43 +0,0 @@
-<!-- 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>