@ersbeth/picoflow 0.0.1 → 0.2.0

package/api/doc/index.md

@@ -19,7 +19,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[picoflow](./picoflow.md)
+[@ersbeth/picoflow](./picoflow.md)
 
 
 </td><td>

package/api/doc/picoflow.array.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; [array](./picoflow.array.md)
+
+## array() function
+
+Creates a new reactive array.
+
+**Signature:**
+
+```typescript
+export declare function array<T>(initial?: T[]): FlowArray<T>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+initial
+
+
+</td><td>
+
+T\[\]
+
+
+</td><td>
+
+_(Optional)_ An optional array of initial values.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[FlowArray](./picoflow.flowarray.md)<!-- -->&lt;T&gt;
+
+A new instance of [FlowArray](./picoflow.flowarray.md)<!-- -->.
+

package/api/doc/picoflow.constant.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; [constant](./picoflow.constant.md)
+
+## constant() function
+
+Creates a new reactive constant.
+
+**Signature:**
+
+```typescript
+export declare function constant<T>(value: T | (() => T)): FlowConstant<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>
+
+The value or a function that returns the value.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[FlowConstant](./picoflow.flowconstant.md)<!-- -->&lt;T&gt;
+
+A new instance of [FlowConstant](./picoflow.flowconstant.md)<!-- -->.
+

package/api/doc/picoflow.derivation.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; [derivation](./picoflow.derivation.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [derivation](./picoflow.derivation.md)
 
 ## derivation() function
 

package/api/doc/picoflow.effect.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; [effect](./picoflow.effect.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [effect](./picoflow.effect.md)
 
 ## effect() function
 

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

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

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

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

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

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

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

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

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

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