@ersbeth/picoflow 0.2.3 → 1.0.0

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

@@ -1,61 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowState](./picoflow.flowstate.md) &gt; [set](./picoflow.flowstate.set.md)
-
-## FlowState.set() method
-
-Updates the state with a new value.
-
-**Signature:**
-
-```typescript
-set(value: T | ((current: T) => T)): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-value
-
-
-</td><td>
-
-T \| ((current: T) =&gt; T)
-
-
-</td><td>
-
-A new value or a callback function that computes a new value based on the current state.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-
-## Exceptions
-
-Error if the state has been disposed.
-
-## Remarks
-
-If the computed new value is strictly equal to the current state value, no change is made and subscribers will not be notified. Otherwise, the state is updated and all subscribers are informed of the change.
-

package/api/doc/picoflow.flowstream._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; [FlowStream](./picoflow.flowstream.md) &gt; [(constructor)](./picoflow.flowstream._constructor_.md)
-
-## FlowStream.(constructor)
-
-Creates a new FlowStream.
-
-**Signature:**
-
-```typescript
-constructor(updater: FlowStreamUpdater<T>);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-updater
-
-
-</td><td>
-
-[FlowStreamUpdater](./picoflow.flowstreamupdater.md)<!-- -->&lt;T&gt;
-
-
-</td><td>
-
-A function that receives a setter to update the stream's value. It should return a disposer function that will be called upon disposal.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.flowstream.dispose.md

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowStream](./picoflow.flowstream.md) &gt; [dispose](./picoflow.flowstream.dispose.md)
-
-## FlowStream.dispose() method
-
-Disposes the stream, releasing all resources.
-
-**Signature:**
-
-```typescript
-dispose(): void;
-```
-**Returns:**
-
-void
-
-## Remarks
-
-In addition to disposing the underlying observable, this method calls the disposer returned by the updater.
-

package/api/doc/picoflow.flowstream.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; [FlowStream](./picoflow.flowstream.md) &gt; [get](./picoflow.flowstream.get.md)
-
-## FlowStream.get() method
-
-Retrieves the current value of the stream.
-
-**Signature:**
-
-```typescript
-get(): T | undefined;
-```
-**Returns:**
-
-T \| undefined
-
-The current value, or undefined if no value has been set yet.
-
-## Exceptions
-
-Error if the stream is disposed.
-

package/api/doc/picoflow.flowstream.md

@@ -1,100 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowStream](./picoflow.flowstream.md)
-
-## FlowStream class
-
-Represents a reactive stream that updates its value based on an updater function.
-
-**Signature:**
-
-```typescript
-export declare class FlowStream<T> extends FlowObservable<T | undefined> 
-```
-**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;T \| undefined&gt;
-
-## Remarks
-
-FlowStream extends FlowObservable to encapsulate an update mechanism provided by an external updater function. The updater is invoked during construction with a setter, and it returns a disposer to be called upon disposal. Note: The stream's current value may be undefined until explicitly set.
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(updater)](./picoflow.flowstream._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Creates a new FlowStream.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[dispose()](./picoflow.flowstream.dispose.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Disposes the stream, releasing all resources.
-
-
-</td></tr>
-<tr><td>
-
-[get()](./picoflow.flowstream.get.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Retrieves the current value of the stream.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.flowstreamasync._constructor_.md

@@ -1,54 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowStreamAsync](./picoflow.flowstreamasync.md) &gt; [(constructor)](./picoflow.flowstreamasync._constructor_.md)
-
-## FlowStreamAsync.(constructor)
-
-Creates a new asynchronous FlowStream.
-
-**Signature:**
-
-```typescript
-constructor(updater: FlowStreamUpdater<T>);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-updater
-
-
-</td><td>
-
-[FlowStreamUpdater](./picoflow.flowstreamupdater.md)<!-- -->&lt;T&gt;
-
-
-</td><td>
-
-A function that receives a setter to update the stream's value. It should return a disposer function that will be called upon disposal.
-
-
-</td></tr>
-</tbody></table>
-
-## Remarks
-
-The updater function can invoke the setter asynchronously to update the stream.
-

package/api/doc/picoflow.flowstreamasync.dispose.md

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowStreamAsync](./picoflow.flowstreamasync.md) &gt; [dispose](./picoflow.flowstreamasync.dispose.md)
-
-## FlowStreamAsync.dispose() method
-
-Disposes the stream, releasing all resources.
-
-**Signature:**
-
-```typescript
-dispose(): void;
-```
-**Returns:**
-
-void
-
-## Remarks
-
-In addition to disposing the underlying observable, this method calls the disposer returned by the updater.
-

package/api/doc/picoflow.flowstreamasync.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; [FlowStreamAsync](./picoflow.flowstreamasync.md) &gt; [get](./picoflow.flowstreamasync.get.md)
-
-## FlowStreamAsync.get() method
-
-Retrieves the current value of the stream as a Promise.
-
-**Signature:**
-
-```typescript
-get(): Promise<T>;
-```
-**Returns:**
-
-Promise&lt;T&gt;
-
-A Promise that resolves to the current value.
-
-## Exceptions
-
-Error if the stream is disposed.
-

package/api/doc/picoflow.flowstreamasync.md

@@ -1,100 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowStreamAsync](./picoflow.flowstreamasync.md)
-
-## FlowStreamAsync class
-
-Represents an asynchronous reactive stream that updates its value based on an updater function.
-
-**Signature:**
-
-```typescript
-export declare class FlowStreamAsync<T> extends FlowObservable<Promise<T>> 
-```
-**Extends:** [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;Promise&lt;T&gt;&gt;
-
-## Remarks
-
-A FlowStreamAsync extends FlowObservable and encapsulates a mechanism for asynchronously updating its value. The updater is invoked during construction with a setter, and its returned disposer is called upon disposal. Note: The stream's current value may be undefined until it is set.
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(updater)](./picoflow.flowstreamasync._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Creates a new asynchronous FlowStream.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[dispose()](./picoflow.flowstreamasync.dispose.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Disposes the stream, releasing all resources.
-
-
-</td></tr>
-<tr><td>
-
-[get()](./picoflow.flowstreamasync.get.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Retrieves the current value of the stream as a Promise.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.flowstreamdisposer.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; [FlowStreamDisposer](./picoflow.flowstreamdisposer.md)
-
-## FlowStreamDisposer type
-
-A function type that disposes of a resource.
-
-**Signature:**
-
-```typescript
-export type FlowStreamDisposer = () => void;
-```

package/api/doc/picoflow.flowstreamsetter.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; [FlowStreamSetter](./picoflow.flowstreamsetter.md)
-
-## FlowStreamSetter type
-
-A function type that sets a new value for the reactive stream.
-
-**Signature:**
-
-```typescript
-export type FlowStreamSetter<T> = (value: T) => void;
-```

package/api/doc/picoflow.flowstreamupdater.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; [FlowStreamUpdater](./picoflow.flowstreamupdater.md)
-
-## FlowStreamUpdater type
-
-A function type that updates a stream and returns a disposer for cleanup.
-
-**Signature:**
-
-```typescript
-export type FlowStreamUpdater<T> = (set: FlowStreamSetter<T>) => FlowStreamDisposer;
-```
-**References:** [FlowStreamSetter](./picoflow.flowstreamsetter.md)<!-- -->, [FlowStreamDisposer](./picoflow.flowstreamdisposer.md)
-
-## Remarks
-
-The updater receives a setter function to update the stream's value. It should return a disposer function to release any resources or subscriptions.
-

package/api/doc/picoflow.flowwatcher.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [FlowWatcher](./picoflow.flowwatcher.md)
-
-## FlowWatcher type
-
-A function for watching a FlowSignal.
-
-**Signature:**
-
-```typescript
-export type FlowWatcher = (signal: FlowSignal) => void;
-```
-**References:** [FlowSignal](./picoflow.flowsignal.md)
-

package/api/doc/picoflow.from.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; [from](./picoflow.from.md)
-
-## from() function
-
-Converts a FlowObservable of a Promise value into a SolidResource.
-
-**Signature:**
-
-```typescript
-export declare function from<T>(flow: FlowObservable<Promise<NotPromise<T>>>): SolidResource<NotPromise<T>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-flow
-
-
-</td><td>
-
-[FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;Promise&lt;NotPromise&lt;T&gt;&gt;&gt;
-
-
-</td><td>
-
-The FlowObservable to convert.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[SolidResource](./picoflow.solidresource.md)<!-- -->&lt;NotPromise&lt;T&gt;&gt;
-
-A SolidResource wrapping the observable.
-

package/api/doc/picoflow.from_1.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; [from](./picoflow.from_1.md)
-
-## from() function
-
-Converts a FlowObservable of a non-Promise value into a SolidDerivation.
-
-**Signature:**
-
-```typescript
-export declare function from<T>(flow: FlowObservable<NotPromise<T>>): SolidDerivation<NotPromise<T>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-flow
-
-
-</td><td>
-
-[FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;NotPromise&lt;T&gt;&gt;
-
-
-</td><td>
-
-The FlowObservable to convert.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[SolidDerivation](./picoflow.solidderivation.md)<!-- -->&lt;NotPromise&lt;T&gt;&gt;
-
-A SolidDerivation wrapping the observable.
-

package/api/doc/picoflow.from_2.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; [from](./picoflow.from_2.md)
-
-## from() function
-
-Converts a FlowObservable into a Solid derivation or resource, depending on whether the value is synchronous or asynchronous.
-
-**Signature:**
-
-```typescript
-export declare function from<T>(flow: FlowObservable<Promise<NotPromise<T>>> | FlowObservable<NotPromise<T>>): SolidDerivation<NotPromise<T>> | SolidResource<NotPromise<T>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-flow
-
-
-</td><td>
-
-[FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;Promise&lt;NotPromise&lt;T&gt;&gt;&gt; \| [FlowObservable](./picoflow.flowobservable.md)<!-- -->&lt;NotPromise&lt;T&gt;&gt;
-
-
-</td><td>
-
-The FlowObservable to convert.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[SolidDerivation](./picoflow.solidderivation.md)<!-- -->&lt;NotPromise&lt;T&gt;&gt; \| [SolidResource](./picoflow.solidresource.md)<!-- -->&lt;NotPromise&lt;T&gt;&gt;
-
-A SolidDerivation or SolidResource, depending on the input type.
-