@ersbeth/picoflow 0.2.3 → 1.0.0

package/api/doc/picoflow.md

@@ -1,544 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md)
-
-## picoflow package
-
-PicoFlow is a lightweight reactive dataflow library that provides a set of reactive primitives such as signals, state, resources, streams, derivations, effects, and reactive maps.
-
-## Classes
-
-<table><thead><tr><th>
-
-Class
-
-
-</th><th>
-
-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)
-
-
-</td><td>
-
-Represents a reactive and immutable constant value computed lazily upon first access.
-
-
-</td></tr>
-<tr><td>
-
-[FlowDerivation](./picoflow.flowderivation.md)
-
-
-</td><td>
-
-Represents a reactive derivation whose value is computed based on other reactive signals.
-
-
-</td></tr>
-<tr><td>
-
-[FlowEffect](./picoflow.floweffect.md)
-
-
-</td><td>
-
-Represents a reactive effect that executes side-effect functions based on its tracked dependencies.
-
-
-</td></tr>
-<tr><td>
-
-[FlowMap](./picoflow.flowmap.md)
-
-
-</td><td>
-
-Represents a reactive map of states extending [FlowState](./picoflow.flowstate.md) for a Map of key/value pairs.
-
-
-</td></tr>
-<tr><td>
-
-[FlowResource](./picoflow.flowresource.md)
-
-
-</td><td>
-
-Represents a reactive resource that asynchronously fetches its value.
-
-
-</td></tr>
-<tr><td>
-
-[FlowResourceAsync](./picoflow.flowresourceasync.md)
-
-
-</td><td>
-
-Represents a reactive resource that asynchronously fetches its value.
-
-
-</td></tr>
-<tr><td>
-
-[FlowSignal](./picoflow.flowsignal.md)
-
-
-</td><td>
-
-Represents a reactive signal.
-
-
-</td></tr>
-<tr><td>
-
-[FlowState](./picoflow.flowstate.md)
-
-
-</td><td>
-
-Represents a reactive state that holds a mutable value.
-
-
-</td></tr>
-<tr><td>
-
-[FlowStream](./picoflow.flowstream.md)
-
-
-</td><td>
-
-Represents a reactive stream that updates its value based on an updater function.
-
-
-</td></tr>
-<tr><td>
-
-[FlowStreamAsync](./picoflow.flowstreamasync.md)
-
-
-</td><td>
-
-Represents an asynchronous reactive stream that updates its value based on an updater function.
-
-
-</td></tr>
-<tr><td>
-
-[SolidDerivation](./picoflow.solidderivation.md)
-
-
-</td><td>
-
-Solid-style derivation, similar to a computed/memoized value.
-
-
-</td></tr>
-<tr><td>
-
-[SolidResource](./picoflow.solidresource.md)
-
-
-</td><td>
-
-Solid-style resource, similar to an async resource or data loader.
-
-
-</td></tr>
-<tr><td>
-
-[SolidState](./picoflow.solidstate.md)
-
-
-</td><td>
-
-Solid-style state container, similar to a writable signal.
-
-
-</td></tr>
-</tbody></table>
-
-## Abstract Classes
-
-<table><thead><tr><th>
-
-Abstract Class
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[FlowObservable](./picoflow.flowobservable.md)
-
-
-</td><td>
-
-Represents a reactive observable that holds and tracks a value.
-
-
-</td></tr>
-</tbody></table>
-
-## Functions
-
-<table><thead><tr><th>
-
-Function
-
-
-</th><th>
-
-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)
-
-
-</td><td>
-
-Creates a new reactive constant.
-
-
-</td></tr>
-<tr><td>
-
-[derivation(fn)](./picoflow.derivation.md)
-
-
-</td><td>
-
-Creates a new reactive derivation whose value is computed based on other reactive signals.
-
-
-</td></tr>
-<tr><td>
-
-[effect(fn)](./picoflow.effect.md)
-
-
-</td><td>
-
-Creates a new reactive effect that executes a side-effect function based on its dependencies.
-
-
-</td></tr>
-<tr><td>
-
-[from(flow)](./picoflow.from.md)
-
-
-</td><td>
-
-Converts a FlowObservable of a Promise value into a SolidResource.
-
-
-</td></tr>
-<tr><td>
-
-[from(flow)](./picoflow.from_1.md)
-
-
-</td><td>
-
-Converts a FlowObservable of a non-Promise value into a SolidDerivation.
-
-
-</td></tr>
-<tr><td>
-
-[from(flow)](./picoflow.from_2.md)
-
-
-</td><td>
-
-Converts a FlowObservable into a Solid derivation or resource, depending on whether the value is synchronous or asynchronous.
-
-
-</td></tr>
-<tr><td>
-
-[from(flow)](./picoflow.from_3.md)
-
-
-</td><td>
-
-Converts a getter function returning a non-Promise value into a SolidDerivation.
-
-
-</td></tr>
-<tr><td>
-
-[from(flow)](./picoflow.from_4.md)
-
-
-</td><td>
-
-Converts a getter function returning a Promise into a SolidResource.
-
-
-</td></tr>
-<tr><td>
-
-[from(flow)](./picoflow.from_5.md)
-
-
-</td><td>
-
-Converts a getter function into a Solid derivation or resource, depending on whether the returned value is synchronous or asynchronous.
-
-
-</td></tr>
-<tr><td>
-
-[isDisposable(obj)](./picoflow.isdisposable.md)
-
-
-</td><td>
-
-Checks whether an object implements the FlowDisposable interface.
-
-
-</td></tr>
-<tr><td>
-
-[map(initial)](./picoflow.map.md)
-
-
-</td><td>
-
-Creates a new reactive map state.
-
-
-</td></tr>
-<tr><td>
-
-[resource(fn)](./picoflow.resource.md)
-
-
-</td><td>
-
-Creates a new reactive resource that asynchronously fetches its value.
-
-
-</td></tr>
-<tr><td>
-
-[resourceAsync(fn)](./picoflow.resourceasync.md)
-
-
-</td><td>
-
-Creates a new reactive asynchronous resource that fetches its value.
-
-
-</td></tr>
-<tr><td>
-
-[signal()](./picoflow.signal.md)
-
-
-</td><td>
-
-Creates a new reactive signal.
-
-
-</td></tr>
-<tr><td>
-
-[state(value)](./picoflow.state.md)
-
-
-</td><td>
-
-Creates a new reactive state holding a value.
-
-
-</td></tr>
-<tr><td>
-
-[stream(updater)](./picoflow.stream.md)
-
-
-</td><td>
-
-Creates a new reactive stream.
-
-
-</td></tr>
-<tr><td>
-
-[streamAsync(updater)](./picoflow.streamasync.md)
-
-
-</td><td>
-
-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>
-<tr><td>
-
-[SolidObservable](./picoflow.solidobservable.md)
-
-
-</td><td>
-
-Interface for a Solid-style observable value.
-
-
-</td></tr>
-</tbody></table>
-
-## Type Aliases
-
-<table><thead><tr><th>
-
-Type Alias
-
-
-</th><th>
-
-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)
-
-
-</td><td>
-
-A function that retrieves the current value from a FlowObservable.
-
-
-</td></tr>
-<tr><td>
-
-[FlowStreamDisposer](./picoflow.flowstreamdisposer.md)
-
-
-</td><td>
-
-A function type that disposes of a resource.
-
-
-</td></tr>
-<tr><td>
-
-[FlowStreamSetter](./picoflow.flowstreamsetter.md)
-
-
-</td><td>
-
-A function type that sets a new value for the reactive stream.
-
-
-</td></tr>
-<tr><td>
-
-[FlowStreamUpdater](./picoflow.flowstreamupdater.md)
-
-
-</td><td>
-
-A function type that updates a stream and returns a disposer for cleanup.
-
-
-</td></tr>
-<tr><td>
-
-[FlowWatcher](./picoflow.flowwatcher.md)
-
-
-</td><td>
-
-A function for watching a FlowSignal.
-
-
-</td></tr>
-<tr><td>
-
-[SolidGetter](./picoflow.solidgetter.md)
-
-
-</td><td>
-
-A getter function or value for Solid state/derivation.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.resource.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; [resource](./picoflow.resource.md)
-
-## resource() function
-
-Creates a new reactive resource that asynchronously fetches its value.
-
-**Signature:**
-
-```typescript
-export declare function resource<T>(fn: () => Promise<T>): FlowResource<T>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-fn
-
-
-</td><td>
-
-() =&gt; Promise&lt;T&gt;
-
-
-</td><td>
-
-An asynchronous function that fetches the resource value.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[FlowResource](./picoflow.flowresource.md)<!-- -->&lt;T&gt;
-
-A new instance of [FlowResource](./picoflow.flowresource.md)<!-- -->.
-

package/api/doc/picoflow.resourceasync.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; [resourceAsync](./picoflow.resourceasync.md)
-
-## resourceAsync() function
-
-Creates a new reactive asynchronous resource that fetches its value.
-
-**Signature:**
-
-```typescript
-export declare function resourceAsync<T>(fn: () => Promise<T>): FlowResourceAsync<T>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-fn
-
-
-</td><td>
-
-() =&gt; Promise&lt;T&gt;
-
-
-</td><td>
-
-An asynchronous function that fetches the resource value.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[FlowResourceAsync](./picoflow.flowresourceasync.md)<!-- -->&lt;T&gt;
-
-A new instance of [FlowResourceAsync](./picoflow.flowresourceasync.md)<!-- -->.
-

package/api/doc/picoflow.signal.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; [signal](./picoflow.signal.md)
-
-## signal() function
-
-Creates a new reactive signal.
-
-**Signature:**
-
-```typescript
-export declare function signal(): FlowSignal;
-```
-**Returns:**
-
-[FlowSignal](./picoflow.flowsignal.md)
-
-A new instance of [FlowSignal](./picoflow.flowsignal.md)<!-- -->.
-

package/api/doc/picoflow.solidderivation._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; [SolidDerivation](./picoflow.solidderivation.md) &gt; [(constructor)](./picoflow.solidderivation._constructor_.md)
-
-## SolidDerivation.(constructor)
-
-Creates a new SolidDerivation from a getter function or value.
-
-**Signature:**
-
-```typescript
-constructor(calculator: SolidGetter<T>);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-calculator
-
-
-</td><td>
-
-[SolidGetter](./picoflow.solidgetter.md)<!-- -->&lt;T&gt;
-
-
-</td><td>
-
-The getter function or value.
-
-
-</td></tr>
-</tbody></table>