@ersbeth/picoflow 0.2.1 → 0.2.3

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

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

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

package/api/doc/picoflow.from_3.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; [from](./picoflow.from_3.md)
+
+## from() function
+
+Converts a getter function returning a non-Promise value into a SolidDerivation.
+
+**Signature:**
+
+```typescript
+export declare function from<T>(flow: (get: FlowGetter) => 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>
+
+(get: [FlowGetter](./picoflow.flowgetter.md)<!-- -->) =&gt; NotPromise&lt;T&gt;
+
+
+</td><td>
+
+The getter function to convert.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[SolidDerivation](./picoflow.solidderivation.md)<!-- -->&lt;NotPromise&lt;T&gt;&gt;
+
+A SolidDerivation wrapping the getter.
+

package/api/doc/picoflow.from_4.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; [from](./picoflow.from_4.md)
+
+## from() function
+
+Converts a getter function returning a Promise into a SolidResource.
+
+**Signature:**
+
+```typescript
+export declare function from<T>(flow: (get: FlowGetter) => 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>
+
+(get: [FlowGetter](./picoflow.flowgetter.md)<!-- -->) =&gt; Promise&lt;NotPromise&lt;T&gt;&gt;
+
+
+</td><td>
+
+The getter function to convert.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[SolidResource](./picoflow.solidresource.md)<!-- -->&lt;NotPromise&lt;T&gt;&gt;
+
+A SolidResource wrapping the getter.
+

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

package/api/doc/picoflow.md

@@ -139,6 +139,39 @@ Represents a reactive stream that updates its value based on an updater function
 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>
 
@@ -224,6 +257,72 @@ 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>
+
+[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>
 
@@ -338,6 +437,17 @@ Description
 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>
 
@@ -419,5 +529,16 @@ A function type that updates a stream and returns a disposer for cleanup.
 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.solidderivation._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; [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>

package/api/doc/picoflow.solidderivation.get.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; [SolidDerivation](./picoflow.solidderivation.md) &gt; [get](./picoflow.solidderivation.get.md)
+
+## SolidDerivation.get property
+
+Returns the current derived value.
+
+**Signature:**
+
+```typescript
+readonly get: () => T;
+```

package/api/doc/picoflow.solidderivation.md

@@ -0,0 +1,94 @@
+<!-- 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)
+
+## SolidDerivation class
+
+Solid-style derivation, similar to a computed/memoized value.
+
+**Signature:**
+
+```typescript
+export declare class SolidDerivation<T> implements SolidObservable<T> 
+```
+**Implements:** [SolidObservable](./picoflow.solidobservable.md)<!-- -->&lt;T&gt;
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(calculator)](./picoflow.solidderivation._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates a new SolidDerivation from a getter function or value.
+
+
+</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>
+
+[get](./picoflow.solidderivation.get.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+() =&gt; T
+
+
+</td><td>
+
+Returns the current derived value.
+
+
+</td></tr>
+</tbody></table>

package/api/doc/picoflow.solidgetter.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; [SolidGetter](./picoflow.solidgetter.md)
+
+## SolidGetter type
+
+A getter function or value for Solid state/derivation.
+
+**Signature:**
+
+```typescript
+export type SolidGetter<T> = ((previous: T) => T) | T;
+```

package/api/doc/picoflow.solidobservable.get.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; [SolidObservable](./picoflow.solidobservable.md) &gt; [get](./picoflow.solidobservable.get.md)
+
+## SolidObservable.get property
+
+Returns the current value.
+
+**Signature:**
+
+```typescript
+get: () => T;
+```