@ersbeth/picoflow 0.2.1 → 0.2.3

package/api/doc/picoflow.solidobservable.md

@@ -0,0 +1,57 @@
+<!-- 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

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

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

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

@@ -0,0 +1,157 @@
+<!-- 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

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

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

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

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

@@ -0,0 +1,115 @@
+<!-- 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

@@ -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; [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/picoflow.public.api.md

@@ -4,6 +4,8 @@
 
 ```ts
 
+import { ResourceFetcher } from 'solid-js';
+
 // @public
 export function array<T>(initial?: T[]): FlowArray<T>;
 
@@ -165,6 +167,26 @@ export type FlowStreamUpdater<T> = (set: FlowStreamSetter<T>) => FlowStreamDispo
 // @public
 export type FlowWatcher = (signal: FlowSignal) => void;
 
+// Warning: (ae-forgotten-export) The symbol "NotPromise" needs to be exported by the entry point index.d.ts
+//
+// @public
+export function from<T>(flow: FlowObservable<Promise<NotPromise<T>>>): SolidResource<NotPromise<T>>;
+
+// @public
+export function from<T>(flow: FlowObservable<NotPromise<T>>): SolidDerivation<NotPromise<T>>;
+
+// @public
+export function from<T>(flow: FlowObservable<Promise<NotPromise<T>>> | FlowObservable<NotPromise<T>>): SolidDerivation<NotPromise<T>> | SolidResource<NotPromise<T>>;
+
+// @public
+export function from<T>(flow: (get: FlowGetter) => NotPromise<T>): SolidDerivation<NotPromise<T>>;
+
+// @public
+export function from<T>(flow: (get: FlowGetter) => Promise<NotPromise<T>>): SolidResource<NotPromise<T>>;
+
+// @public
+export function from<T>(flow: ((get: FlowGetter) => NotPromise<T>) | ((get: FlowGetter) => Promise<NotPromise<T>>)): SolidDerivation<T> | SolidResource<T>;
+
 // @public
 export function isDisposable(obj: unknown): obj is FlowDisposable;
 
@@ -180,6 +202,36 @@ export function resourceAsync<T>(fn: () => Promise<T>): FlowResourceAsync<T>;
 // @public
 export function signal(): FlowSignal;
 
+// @public
+export class SolidDerivation<T> implements SolidObservable<T> {
+    constructor(calculator: SolidGetter<T>);
+    readonly get: () => T;
+}
+
+// @public
+export type SolidGetter<T> = ((previous: T) => T) | T;
+
+// @public
+export interface SolidObservable<T> {
+    get: () => T;
+}
+
+// @public
+export class SolidResource<T> implements SolidObservable<T | undefined> {
+    constructor(fetcher: ResourceFetcher<true, T, unknown>);
+    readonly get: () => T | undefined;
+    readonly latest: () => T | undefined;
+    readonly refetch: () => void;
+    readonly state: () => 'unresolved' | 'pending' | 'errored' | 'ready' | 'refreshing';
+}
+
+// @public
+export class SolidState<T> implements SolidObservable<T> {
+    constructor(initialValue: T);
+    readonly get: () => T;
+    readonly set: (param: SolidGetter<T>) => void;
+}
+
 // @public
 export function state<T>(value: T | (() => T)): FlowState<T>;