@ersbeth/picoflow 0.2.3 → 1.0.0

package/api/doc/picoflow.from_3.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_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

@@ -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_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

@@ -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_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.isdisposable.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; [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.map.md

@@ -1,59 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [map](./picoflow.map.md)
-
-## map() function
-
-Creates a new reactive map state.
-
-**Signature:**
-
-```typescript
-export declare function map<K extends string | number | symbol, V>(initial?: Record<K, V>): FlowMap<K, V>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-initial
-
-
-</td><td>
-
-Record&lt;K, V&gt;
-
-
-</td><td>
-
-_(Optional)_ An optional record of key-value pairs to initialize the map.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[FlowMap](./picoflow.flowmap.md)<!-- -->&lt;K, V&gt;
-
-A new instance of [FlowMap](./picoflow.flowmap.md)<!-- -->.
-
-## Remarks
-
-The initial record is converted to a native Map before being used.
-