@ersbeth/picoflow 0.2.4 → 1.0.1

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

@@ -1,94 +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)
-
-## 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

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

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

package/api/doc/picoflow.solidobservable.md

@@ -1,57 +0,0 @@
-<!-- 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)
-
-## SolidObservable interface
-
-Interface for a Solid-style observable value.
-
-**Signature:**
-
-```typescript
-export interface SolidObservable<T> 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[get](./picoflow.solidobservable.get.md)
-
-
-</td><td>
-
-
-</td><td>
-
-() =&gt; T
-
-
-</td><td>
-
-Returns the current value.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.solidresource._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; [SolidResource](./picoflow.solidresource.md) &gt; [(constructor)](./picoflow.solidresource._constructor_.md)
-
-## SolidResource.(constructor)
-
-Creates a new SolidResource from a fetcher function.
-
-**Signature:**
-
-```typescript
-constructor(fetcher: ResourceFetcher<true, T, unknown>);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-fetcher
-
-
-</td><td>
-
-ResourceFetcher&lt;true, T, unknown&gt;
-
-
-</td><td>
-
-The async fetcher function.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.solidresource.get.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; [SolidResource](./picoflow.solidresource.md) &gt; [get](./picoflow.solidresource.get.md)
-
-## SolidResource.get property
-
-Returns the current value (or undefined if not yet loaded).
-
-**Signature:**
-
-```typescript
-readonly get: () => T | undefined;
-```

package/api/doc/picoflow.solidresource.latest.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; [SolidResource](./picoflow.solidresource.md) &gt; [latest](./picoflow.solidresource.latest.md)
-
-## SolidResource.latest property
-
-Returns the latest successfully loaded value (or undefined).
-
-**Signature:**
-
-```typescript
-readonly latest: () => T | undefined;
-```

package/api/doc/picoflow.solidresource.md

@@ -1,157 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [SolidResource](./picoflow.solidresource.md)
-
-## SolidResource class
-
-Solid-style resource, similar to an async resource or data loader.
-
-**Signature:**
-
-```typescript
-export declare class SolidResource<T> implements SolidObservable<T | undefined> 
-```
-**Implements:** [SolidObservable](./picoflow.solidobservable.md)<!-- -->&lt;T \| undefined&gt;
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(fetcher)](./picoflow.solidresource._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Creates a new SolidResource from a fetcher function.
-
-
-</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.solidresource.get.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-() =&gt; T \| undefined
-
-
-</td><td>
-
-Returns the current value (or undefined if not yet loaded).
-
-
-</td></tr>
-<tr><td>
-
-[latest](./picoflow.solidresource.latest.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-() =&gt; T \| undefined
-
-
-</td><td>
-
-Returns the latest successfully loaded value (or undefined).
-
-
-</td></tr>
-<tr><td>
-
-[refetch](./picoflow.solidresource.refetch.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-() =&gt; void
-
-
-</td><td>
-
-Triggers a refetch of the resource.
-
-
-</td></tr>
-<tr><td>
-
-[state](./picoflow.solidresource.state.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-() =&gt; 'unresolved' \| 'pending' \| 'errored' \| 'ready' \| 'refreshing'
-
-
-</td><td>
-
-Returns the current resource state.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.solidresource.refetch.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; [SolidResource](./picoflow.solidresource.md) &gt; [refetch](./picoflow.solidresource.refetch.md)
-
-## SolidResource.refetch property
-
-Triggers a refetch of the resource.
-
-**Signature:**
-
-```typescript
-readonly refetch: () => void;
-```

package/api/doc/picoflow.solidresource.state.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; [SolidResource](./picoflow.solidresource.md) &gt; [state](./picoflow.solidresource.state.md)
-
-## SolidResource.state property
-
-Returns the current resource state.
-
-**Signature:**
-
-```typescript
-readonly state: () => 'unresolved' | 'pending' | 'errored' | 'ready' | 'refreshing';
-```

package/api/doc/picoflow.solidstate._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; [SolidState](./picoflow.solidstate.md) &gt; [(constructor)](./picoflow.solidstate._constructor_.md)
-
-## SolidState.(constructor)
-
-Creates a new SolidState with the given initial value.
-
-**Signature:**
-
-```typescript
-constructor(initialValue: T);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-initialValue
-
-
-</td><td>
-
-T
-
-
-</td><td>
-
-The initial value.
-
-
-</td></tr>
-</tbody></table>

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

package/api/doc/picoflow.solidstate.md

@@ -1,115 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [SolidState](./picoflow.solidstate.md)
-
-## SolidState class
-
-Solid-style state container, similar to a writable signal.
-
-**Signature:**
-
-```typescript
-export declare class SolidState<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)(initialValue)](./picoflow.solidstate._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Creates a new SolidState with the given initial 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.solidstate.get.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-() =&gt; T
-
-
-</td><td>
-
-Returns the current value.
-
-
-</td></tr>
-<tr><td>
-
-[set](./picoflow.solidstate.set.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-(param: [SolidGetter](./picoflow.solidgetter.md)<!-- -->&lt;T&gt;) =&gt; void
-
-
-</td><td>
-
-Sets the value or updates it using a getter function.
-
-
-</td></tr>
-</tbody></table>

package/api/doc/picoflow.solidstate.set.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; [SolidState](./picoflow.solidstate.md) &gt; [set](./picoflow.solidstate.set.md)
-
-## SolidState.set property
-
-Sets the value or updates it using a getter function.
-
-**Signature:**
-
-```typescript
-readonly set: (param: SolidGetter<T>) => void;
-```

package/api/doc/picoflow.state.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; [state](./picoflow.state.md)
-
-## state() function
-
-Creates a new reactive state holding a value.
-
-**Signature:**
-
-```typescript
-export declare function state<T>(value: T | (() => T)): FlowState<T>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-value
-
-
-</td><td>
-
-T \| (() =&gt; T)
-
-
-</td><td>
-
-The initial value for the state.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[FlowState](./picoflow.flowstate.md)<!-- -->&lt;T&gt;
-
-A new instance of [FlowState](./picoflow.flowstate.md)<!-- -->.
-