@ersbeth/picoflow 2.0.2 → 2.0.3

package/docs/api/functions/from.md

@@ -1,129 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / from
-
-# Function: from()
-
-## Call Signature
-
-```ts
-function from<T>(flow): Resource<T>;
-```
-
-Defined in: [converters/solid.ts:97](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/converters/solid.ts#L97)
-
-Converts a PicoFlow observable or getter function into a SolidJS resource.
-
-### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `flow` | [`FlowObservable`](/api/interfaces/FlowObservable.md)\<`T`\> | The FlowObservable or getter function to convert. |
-
-### Returns
-
-`Resource`\<`T`\>
-
-A SolidJS Resource that wraps the value or computation.
-
-### Remarks
-
-This function bridges PicoFlow's reactive system with SolidJS, allowing you to use
-PicoFlow primitives and computations within Solid components. All conversions return a
-SolidJS Resource, which can handle both synchronous and asynchronous values seamlessly.
-
-The conversion works with:
-- **FlowObservable**: Any PicoFlow reactive primitive (e.g., from `state()`, `derivation()`, `stateAsync()`, `derivationAsync()`)
-- **Getter functions**: Computation functions that use a FlowTracker to access reactive values
-
-The created Resource automatically subscribes to the PicoFlow observables and updates
-when their values change. The subscription is properly cleaned up when the Solid
-component unmounts.
-
-### Example
-
-```typescript
-import { from } from 'picoflow/solid';
-import { state, derivation } from 'picoflow';
-
-// Convert a PicoFlow state to a Solid resource
-const $count = state(0);
-const solidCount = from($count);
-
-// Use in a Solid component
-function Counter() {
-  return <div>Count: {solidCount()}</div>;
-}
-
-// Or convert a computation function
-const solidDerived = from((t) => {
-  return $count.get(t) * 2;
-});
-```
-
-## Call Signature
-
-```ts
-function from<T>(flow): Resource<T>;
-```
-
-Defined in: [converters/solid.ts:98](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/converters/solid.ts#L98)
-
-Converts a PicoFlow observable or getter function into a SolidJS resource.
-
-### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `flow` | (`t`) => [`NotPromise`](/api/type-aliases/NotPromise.md)\<`T`\> | The FlowObservable or getter function to convert. |
-
-### Returns
-
-`Resource`\<`T`\>
-
-A SolidJS Resource that wraps the value or computation.
-
-### Remarks
-
-This function bridges PicoFlow's reactive system with SolidJS, allowing you to use
-PicoFlow primitives and computations within Solid components. All conversions return a
-SolidJS Resource, which can handle both synchronous and asynchronous values seamlessly.
-
-The conversion works with:
-- **FlowObservable**: Any PicoFlow reactive primitive (e.g., from `state()`, `derivation()`, `stateAsync()`, `derivationAsync()`)
-- **Getter functions**: Computation functions that use a FlowTracker to access reactive values
-
-The created Resource automatically subscribes to the PicoFlow observables and updates
-when their values change. The subscription is properly cleaned up when the Solid
-component unmounts.
-
-### Example
-
-```typescript
-import { from } from 'picoflow/solid';
-import { state, derivation } from 'picoflow';
-
-// Convert a PicoFlow state to a Solid resource
-const $count = state(0);
-const solidCount = from($count);
-
-// Use in a Solid component
-function Counter() {
-  return <div>Count: {solidCount()}</div>;
-}
-
-// Or convert a computation function
-const solidDerived = from((t) => {
-  return $count.get(t) * 2;
-});
-```

package/docs/api/functions/isDisposable.md

@@ -1,27 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / isDisposable
-
-# Function: isDisposable()
-
-```ts
-function isDisposable(obj): obj is FlowDisposable;
-```
-
-Defined in: [api/base/flowDisposable.ts:42](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L42)
-
-Type guard to check if an object implements the FlowDisposable interface.
-
-Useful for conditionally disposing objects that may or may not be disposable,
-such as when cleaning up mixed collections of values. Returns true if the object
-has a `dispose` method, providing type-safe access to disposal functionality.
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `obj` | `unknown` | The object to check |
-
-## Returns
-
-`obj is FlowDisposable`
-
-True if the object implements FlowDisposable, false otherwise

package/docs/api/functions/map.md

@@ -1,36 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / map
-
-# Function: map()
-
-```ts
-function map<K, V>(initial?): FlowMap<K, V>;
-```
-
-Defined in: [api/nodes/collections/flowMap.ts:110](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/collections/flowMap.ts#L110)
-
-Creates a reactive map with mutation methods and fine-grained action tracking.
-
-The map starts with the provided initial entries (or empty if none provided). All mutation methods
-(add, update, delete) notify dependents and emit detailed action information to `$lastAction`.
-Use the map itself for coarse-grained reactivity, or subscribe to `$lastAction` for fine-grained
-reactivity to specific mutation types. Useful for entity stores, lookup tables, or any key-value
-data that needs reactive updates.
-
-## Type Parameters
-
-| Type Parameter |
-| ------ |
-| `K` *extends* `string` \| `number` \| `symbol` |
-| `V` |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `initial?` | `Record`\<`K`, `V`\> \| `Map`\<`K`, `V`\> | Optional initial entries as a Record or Map |
-
-## Returns
-
-[`FlowMap`](/api/interfaces/FlowMap.md)\<`K`, `V`\>
-
-A FlowMap with reactive mutation methods

package/docs/api/functions/signal.md

@@ -1,21 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / signal
-
-# Function: signal()
-
-```ts
-function signal(): FlowSignal;
-```
-
-Defined in: [api/nodes/flowSignal.ts:26](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowSignal.ts#L26)
-
-Creates a signal that can be manually triggered to notify dependents.
-
-Signals act as event emitters in the reactive graph. Call `trigger()` to notify all subscribers
-and reactive computations that depend on the signal. Unlike state or derivations, signals don't
-carry data values - they simply represent that an event occurred.
-
-## Returns
-
-[`FlowSignal`](/api/interfaces/FlowSignal.md)
-
-A FlowSignal that can be triggered manually and subscribed to

package/docs/api/functions/state.md

@@ -1,67 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / state
-
-# Function: state()
-
-## Call Signature
-
-```ts
-function state<T>(value): FlowState<T>;
-```
-
-Defined in: [api/nodes/sync/flowState.ts:41](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowState.ts#L41)
-
-Creates a mutable reactive state that can be read and updated imperatively.
-
-State can be initialized with a direct value or a lazy initializer function. Changes propagate
-automatically to all reactive computations that depend on this state. Use state for data that
-changes through user actions, external events, or application logic rather than derived computations.
-
-### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | [`NotPromise`](/api/type-aliases/NotPromise.md)\<`T`\> | Initial value for the state, or lazy initializer function |
-
-### Returns
-
-[`FlowState`](/api/interfaces/FlowState.md)\<`T`\>
-
-A FlowState that can be read and modified
-
-## Call Signature
-
-```ts
-function state<T>(initializer): FlowState<T>;
-```
-
-Defined in: [api/nodes/sync/flowState.ts:42](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowState.ts#L42)
-
-Creates a mutable reactive state that can be read and updated imperatively.
-
-State can be initialized with a direct value or a lazy initializer function. Changes propagate
-automatically to all reactive computations that depend on this state. Use state for data that
-changes through user actions, external events, or application logic rather than derived computations.
-
-### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `initializer` | [`InitFunction`](/api/type-aliases/InitFunction.md)\<`T`\> |
-
-### Returns
-
-[`FlowState`](/api/interfaces/FlowState.md)\<`T`\>
-
-A FlowState that can be read and modified

package/docs/api/functions/stateAsync.md

@@ -1,69 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / stateAsync
-
-# Function: stateAsync()
-
-## Call Signature
-
-```ts
-function stateAsync<T>(value): FlowStateAsync<T>;
-```
-
-Defined in: [api/nodes/async/flowStateAsync.ts:43](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/async/flowStateAsync.ts#L43)
-
-Creates a mutable async reactive state that resolves promises and can be updated imperatively.
-
-State can be initialized with a direct promise or a lazy async initializer function. Update the state by
-calling `set()` with a new promise or an async updater function. Changes propagate automatically to all
-reactive computations that depend on this state. Use for async data that changes through user actions or
-application logic, such as loading user profiles, fetching search results, or any async state updates.
-
-### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `Promise`\<`T`\> | Initial promise to resolve, or lazy async initializer function |
-
-### Returns
-
-[`FlowStateAsync`](/api/interfaces/FlowStateAsync.md)\<`T`\>
-
-A FlowStateAsync that can be read and modified with promises
-
-## Call Signature
-
-```ts
-function stateAsync<T>(initializer): FlowStateAsync<T>;
-```
-
-Defined in: [api/nodes/async/flowStateAsync.ts:44](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/async/flowStateAsync.ts#L44)
-
-Creates a mutable async reactive state that resolves promises and can be updated imperatively.
-
-State can be initialized with a direct promise or a lazy async initializer function. Update the state by
-calling `set()` with a new promise or an async updater function. Changes propagate automatically to all
-reactive computations that depend on this state. Use for async data that changes through user actions or
-application logic, such as loading user profiles, fetching search results, or any async state updates.
-
-### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `initializer` | [`InitFunctionAsync`](/api/type-aliases/InitFunctionAsync.md)\<`T`\> |
-
-### Returns
-
-[`FlowStateAsync`](/api/interfaces/FlowStateAsync.md)\<`T`\>
-
-A FlowStateAsync that can be read and modified with promises

package/docs/api/functions/subscribe.md

@@ -1,40 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / subscribe
-
-# Function: subscribe()
-
-```ts
-function subscribe<T>(
-   data, 
-   onData, 
-   onError?, 
-   onPending?): FlowEffect;
-```
-
-Defined in: [api/nodes/flowEffect.ts:35](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowEffect.ts#L35)
-
-Creates a reactive effect that runs immediately and automatically re-runs when dependencies change.
-
-The effect function tracks any reactive values accessed and subscribes to their changes.
-When any tracked value changes, the effect re-executes with the new values.
-Optional callbacks handle errors and pending async states.
-
-## Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `data` | [`FlowDataTracker`](/api/type-aliases/FlowDataTracker.md)\<`T`\> | Function that accesses reactive dependencies and returns data |
-| `onData` | [`FlowOnDataListener`](/api/type-aliases/FlowOnDataListener.md)\<`T`\> | Callback invoked with the computed data on each execution |
-| `onError?` | [`FlowOnErrorListener`](/api/type-aliases/FlowOnErrorListener.md) | Optional callback for handling errors during execution |
-| `onPending?` | [`FlowOnPendingListener`](/api/type-aliases/FlowOnPendingListener.md) | Optional callback invoked when async dependencies are pending |
-
-## Returns
-
-[`FlowEffect`](/api/interfaces/FlowEffect.md)
-
-A FlowEffect handle with a `dispose()` method to stop the effect

package/docs/api/functions/writableDerivation.md

@@ -1,33 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / writableDerivation
-
-# Function: writableDerivation()
-
-```ts
-function writableDerivation<T>(compute): FlowWritableDerivation<T>;
-```
-
-Defined in: [api/nodes/sync/flowWritableDerivation.ts:29](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowWritableDerivation.ts#L29)
-
-Creates a derived value that recomputes automatically but can also be manually overridden.
-
-The compute function tracks dependencies and recomputes when they change, just like a regular derivation.
-However, you can also call `set()` to override the computed value. Use this for values that are normally
-derived but need occasional manual adjustments, such as editable calculated fields or user-correctable totals.
-
-## Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `compute` | [`DerivationFunction`](/api/type-aliases/DerivationFunction.md)\<`T`\> | Function that accesses dependencies and computes the derived value |
-
-## Returns
-
-[`FlowWritableDerivation`](/api/interfaces/FlowWritableDerivation.md)\<`T`\>
-
-A FlowWritableDerivation that provides both reactive computation and manual control

package/docs/api/functions/writableDerivationAsync.md

@@ -1,34 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / writableDerivationAsync
-
-# Function: writableDerivationAsync()
-
-```ts
-function writableDerivationAsync<T>(compute): FlowWritableDerivationAsync<T>;
-```
-
-Defined in: [api/nodes/async/flowWritableDerivationAsync.ts:31](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/async/flowWritableDerivationAsync.ts#L31)
-
-Creates an async derived value that recomputes automatically but can also be manually overridden.
-
-The async compute function tracks dependencies and returns a promise. When any tracked dependency changes,
-the function runs again and returns a new promise. However, you can also call `set()` to override the computed
-value with a new promise. Use for async values that are normally derived but need occasional manual adjustments,
-such as editable async calculated fields or user-correctable async totals.
-
-## Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `compute` | [`DerivationFunctionAsync`](/api/type-aliases/DerivationFunctionAsync.md)\<`T`\> | Async function that accesses dependencies and returns a promise of the derived value |
-
-## Returns
-
-[`FlowWritableDerivationAsync`](/api/interfaces/FlowWritableDerivationAsync.md)\<`T`\>
-
-A FlowWritableDerivationAsync that provides both reactive async computation and manual control

package/docs/api/index.md

@@ -1,61 +0,0 @@
-# @ersbeth/picoflow
-
-## Interfaces
-
-| Interface | Description |
-| ------ | ------ |
-| [FlowArray](/api/interfaces/FlowArray.md) | Reactive array with standard mutation methods and fine-grained change tracking. |
-| [FlowConstant](/api/interfaces/FlowConstant.md) | Read-only reactive value that computes once on initialization and never changes. |
-| [FlowConstantAsync](/api/interfaces/FlowConstantAsync.md) | Read-only reactive value that resolves once from a promise or async initializer. |
-| [FlowDerivation](/api/interfaces/FlowDerivation.md) | Read-only reactive value that recomputes automatically when dependencies change. |
-| [FlowDerivationAsync](/api/interfaces/FlowDerivationAsync.md) | Read-only reactive value that recomputes asynchronously when dependencies change. |
-| [FlowDisposable](/api/interfaces/FlowDisposable.md) | Contract for resources that can be explicitly released to prevent memory leaks. |
-| [FlowEffect](/api/interfaces/FlowEffect.md) | Handle to a reactive effect that automatically tracks dependencies and re-executes when they change. |
-| [FlowMap](/api/interfaces/FlowMap.md) | Reactive map with standard mutation methods and fine-grained change tracking. |
-| [FlowObservable](/api/interfaces/FlowObservable.md) | Contract for reactive primitives that emit changes and notify their dependents in the reactivity graph. |
-| [FlowSignal](/api/interfaces/FlowSignal.md) | Manual trigger that notifies subscribers without carrying data. |
-| [FlowState](/api/interfaces/FlowState.md) | Writable reactive value that can be updated manually and notifies dependents on changes. |
-| [FlowStateAsync](/api/interfaces/FlowStateAsync.md) | Writable reactive value that resolves promises and can be updated with new promises. |
-| [FlowSubscribable](/api/interfaces/FlowSubscribable.md) | Contract for observables that can be subscribed to with lifecycle callbacks. |
-| [FlowTracker](/api/interfaces/FlowTracker.md) | Contract for reactive computations that track dependencies and react to changes in the reactivity graph. |
-| [FlowValue](/api/interfaces/FlowValue.md) | Base interface for reactive values that can be read synchronously or asynchronously. |
-| [FlowWritableDerivation](/api/interfaces/FlowWritableDerivation.md) | Writable reactive value that recomputes automatically when dependencies change, but can be manually overridden. |
-| [FlowWritableDerivationAsync](/api/interfaces/FlowWritableDerivationAsync.md) | Writable reactive value that recomputes asynchronously when dependencies change, but can be manually overridden. |
-
-## Type Aliases
-
-| Type Alias | Description |
-| ------ | ------ |
-| [DerivationFunction](/api/type-aliases/DerivationFunction.md) | Function that derives a value from dependencies and optionally the previous value. |
-| [DerivationFunctionAsync](/api/type-aliases/DerivationFunctionAsync.md) | Function that derives a value asynchronously from dependencies and optionally the previous value. |
-| [FlowArrayAction](/api/type-aliases/FlowArrayAction.md) | Discriminated union representing all possible array mutation operations. |
-| [FlowDataTracker](/api/type-aliases/FlowDataTracker.md) | Function that tracks reactive dependencies and returns data. |
-| [FlowMapAction](/api/type-aliases/FlowMapAction.md) | Discriminated union representing all possible map mutation operations. |
-| [FlowOnDataListener](/api/type-aliases/FlowOnDataListener.md) | Callback invoked when new data is available. |
-| [FlowOnErrorListener](/api/type-aliases/FlowOnErrorListener.md) | Callback invoked when an error occurs during effect execution. |
-| [FlowOnPendingListener](/api/type-aliases/FlowOnPendingListener.md) | Callback invoked when an async computation is pending. |
-| [FlowReadonly](/api/type-aliases/FlowReadonly.md) | Type that restricts mutation methods to create read-only versions of reactive primitives. |
-| [InitFunction](/api/type-aliases/InitFunction.md) | Function that initializes a value. |
-| [InitFunctionAsync](/api/type-aliases/InitFunctionAsync.md) | Function that initializes a value asynchronously. |
-| [NotPromise](/api/type-aliases/NotPromise.md) | Type that excludes Promise values from a type union. |
-| [UpdateFunction](/api/type-aliases/UpdateFunction.md) | Function that updates a value based on the previous value. |
-| [UpdateFunctionAsync](/api/type-aliases/UpdateFunctionAsync.md) | Function that updates a value asynchronously based on the previous value. |
-
-## Functions
-
-| Function | Description |
-| ------ | ------ |
-| [array](/api/functions/array.md) | Creates a reactive array with mutation methods and fine-grained action tracking. |
-| [constant](/api/functions/constant.md) | Creates a constant reactive value that initializes lazily and never recomputes. |
-| [constantAsync](/api/functions/constantAsync.md) | Creates a constant reactive value from a promise or async initializer that resolves once and never recomputes. |
-| [derivation](/api/functions/derivation.md) | Creates a derived reactive value that automatically recomputes when dependencies change. |
-| [derivationAsync](/api/functions/derivationAsync.md) | Creates an async derived value that automatically recomputes when dependencies change. |
-| [from](/api/functions/from.md) | Converts a PicoFlow observable or getter function into a SolidJS resource. |
-| [isDisposable](/api/functions/isDisposable.md) | Type guard to check if an object implements the FlowDisposable interface. |
-| [map](/api/functions/map.md) | Creates a reactive map with mutation methods and fine-grained action tracking. |
-| [signal](/api/functions/signal.md) | Creates a signal that can be manually triggered to notify dependents. |
-| [state](/api/functions/state.md) | Creates a mutable reactive state that can be read and updated imperatively. |
-| [stateAsync](/api/functions/stateAsync.md) | Creates a mutable async reactive state that resolves promises and can be updated imperatively. |
-| [subscribe](/api/functions/subscribe.md) | Creates a reactive effect that runs immediately and automatically re-runs when dependencies change. |
-| [writableDerivation](/api/functions/writableDerivation.md) | Creates a derived value that recomputes automatically but can also be manually overridden. |
-| [writableDerivationAsync](/api/functions/writableDerivationAsync.md) | Creates an async derived value that recomputes automatically but can also be manually overridden. |