@ersbeth/picoflow 0.1.0 → 0.2.1

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.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.flowsignal.dispose.md

@@ -9,8 +9,46 @@ Disposes the FlowSignal. Cleans up all registered effects, listeners, and depend
 **Signature:**
 
 ```typescript
-dispose(): void;
+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

package/api/doc/picoflow.flowsignal.md

@@ -9,8 +9,9 @@ Represents a reactive signal.
 **Signature:**
 
 ```typescript
-export declare class FlowSignal 
+export declare class FlowSignal implements FlowDisposable 
 ```
+**Implements:** [FlowDisposable](./picoflow.flowdisposable.md)
 
 ## Remarks
 
@@ -82,7 +83,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[dispose()](./picoflow.flowsignal.dispose.md)
+[dispose(options)](./picoflow.flowsignal.dispose.md)
 
 
 </td><td>

package/api/doc/picoflow.isdisposable.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; [isDisposable](./picoflow.isdisposable.md)
+
+## isDisposable() function
+
+Checks whether an object implements the FlowDisposable interface.
+
+**Signature:**
+
+```typescript
+export declare function isDisposable(obj: unknown): obj is FlowDisposable;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+obj
+
+
+</td><td>
+
+unknown
+
+
+</td><td>
+
+The object to test.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+obj is [FlowDisposable](./picoflow.flowdisposable.md)
+
+True if the object has a dispose method, otherwise false.
+

package/api/doc/picoflow.md

@@ -21,6 +21,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[FlowArray](./picoflow.flowarray.md)
+
+
+</td><td>
+
+Represents a reactive array.
+
+
+</td></tr>
+<tr><td>
+
 [FlowConstant](./picoflow.flowconstant.md)
 
 
@@ -172,6 +183,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[array(initial)](./picoflow.array.md)
+
+
+</td><td>
+
+Creates a new reactive array.
+
+
+</td></tr>
+<tr><td>
+
 [constant(value)](./picoflow.constant.md)
 
 
@@ -202,6 +224,17 @@ Creates a new reactive derivation whose value is computed based on other reactiv
 Creates a new reactive effect that executes a side-effect function based on its dependencies.
 
 
+</td></tr>
+<tr><td>
+
+[isDisposable(obj)](./picoflow.isdisposable.md)
+
+
+</td><td>
+
+Checks whether an object implements the FlowDisposable interface.
+
+
 </td></tr>
 <tr><td>
 
@@ -279,6 +312,32 @@ Creates a new reactive stream.
 Creates a new reactive asynchronous stream.
 
 
+</td></tr>
+</tbody></table>
+
+## Interfaces
+
+<table><thead><tr><th>
+
+Interface
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[FlowDisposable](./picoflow.flowdisposable.md)
+
+
+</td><td>
+
+Represents an object with a disposable lifecycle.
+
+
 </td></tr>
 </tbody></table>
 
@@ -297,6 +356,17 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[FlowArrayAction](./picoflow.flowarrayaction.md)
+
+
+</td><td>
+
+Represents the actions that can be performed on a FlowArray.
+
+
+</td></tr>
+<tr><td>
+
 [FlowGetter](./picoflow.flowgetter.md)
 
 

package/api/picoflow.public.api.md

@@ -4,6 +4,9 @@
 
 ```ts
 
+// @public
+export function array<T>(initial?: T[]): FlowArray<T>;
+
 // @public
 export function constant<T>(value: T | (() => T)): FlowConstant<T>;
 
@@ -13,6 +16,52 @@ export function derivation<T>(fn: (get: FlowGetter, watch: FlowWatcher) => T): F
 // @public
 export function effect(fn: (get: FlowGetter, watch: FlowWatcher) => void): FlowEffect;
 
+// @public
+export class FlowArray<T> extends FlowObservable<T[]> {
+    $lastAction: FlowState<FlowArrayAction<T>>;
+    constructor(value?: T[]);
+    clear(): void;
+    dispose(options?: {
+        self: boolean;
+    }): void;
+    get(): T[];
+    get length(): number;
+    pop(): void;
+    push(item: T): void;
+    set(items: T[]): void;
+    setItem(index: number, item: T): void;
+    shift(): void;
+    splice(start: number, deleteCount: number, ...newItems: T[]): void;
+    unshift(item: T): void;
+}
+
+// @public
+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";
+};
+
 // @public
 export class FlowConstant<T> extends FlowObservable<T> {
     constructor(value: T | (() => T));
@@ -25,6 +74,13 @@ export class FlowDerivation<T> extends FlowObservable<T> {
     get(): T;
 }
 
+// @public
+export interface FlowDisposable {
+    dispose(options?: {
+        self: boolean;
+    }): void;
+}
+
 // @public
 export class FlowEffect {
     constructor(apply: (get: FlowGetter, watch: FlowWatcher) => void);
@@ -70,8 +126,10 @@ export class FlowResourceAsync<T> extends FlowObservable<Promise<T>> {
 }
 
 // @public
-export class FlowSignal {
-    dispose(): void;
+export class FlowSignal implements FlowDisposable {
+    dispose(options?: {
+        self: boolean;
+    }): void;
     get disposed(): boolean;
     trigger(): void;
 }
@@ -107,6 +165,9 @@ export type FlowStreamUpdater<T> = (set: FlowStreamSetter<T>) => FlowStreamDispo
 // @public
 export type FlowWatcher = (signal: FlowSignal) => void;
 
+// @public
+export function isDisposable(obj: unknown): obj is FlowDisposable;
+
 // @public
 export function map<K extends string | number | symbol, V>(initial?: Record<K, V>): FlowMap<K, V>;