@ersbeth/picoflow 0.2.3 → 1.0.0

package/docs/api/classes/FlowState.md

@@ -0,0 +1,368 @@
+[@ersbeth/picoflow](/api/index.md) / FlowState
+
+# Class: FlowState\<T\>
+
+Defined in: [basic/state.ts:36](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/state.ts#L36)
+
+Represents a reactive state that holds a mutable value.
+
+## Remarks
+
+FlowState extends FlowConstant and inherits reactive value access methods from FlowObservable.
+You can read the state value using `get(context)` for tracked access or `pick()` for untracked access.
+Use the [FlowState.set](/api/classes/FlowState.md#set) method to update the state value.
+
+When the state is updated with a new value that differs from the current value, all dependent
+effects and derivations are automatically notified and re-executed. If the new value is strictly
+equal to the current value, no notification occurs.
+
+## Example
+
+```typescript
+const $count = state(0);
+
+// Read with tracking
+effect((t) => {
+  console.log($count.get(t)); // Effect re-runs when $count changes
+});
+
+// Read without tracking
+const snapshot = $count.pick();
+
+// Update the value
+$count.set(1);
+$count.set(current => current + 1);
+```
+
+## Extends
+
+- [`FlowConstant`](/api/classes/FlowConstant.md)\<`T`\>
+
+## Extended by
+
+- [`FlowMap`](/api/classes/FlowMap.md)
+
+## Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The type of the state value. |
+
+## Constructors
+
+### Constructor
+
+```ts
+new FlowState<T>(value): FlowState<T>;
+```
+
+Defined in: [basic/constant.ts:59](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/constant.ts#L59)
+
+Creates a new FlowConstant instance.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `T` \| () => `T` | Either a direct value of type T or a function returning a value of type T. If a function is provided, it will be invoked lazily on the first value access. If a direct value is provided, it is stored immediately. |
+
+#### Returns
+
+`FlowState`\<`T`\>
+
+#### Inherited from
+
+[`FlowConstant`](/api/classes/FlowConstant.md).[`constructor`](/api/classes/FlowConstant.md#constructor)
+
+## Accessors
+
+### disposed
+
+#### Get Signature
+
+```ts
+get disposed(): boolean;
+```
+
+Defined in: [basic/signal.ts:97](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/signal.ts#L97)
+
+Indicates whether the FlowSignal has been disposed.
+
+##### Remarks
+
+Once disposed, the signal should not be used.
+
+##### Returns
+
+`boolean`
+
+#### Inherited from
+
+[`FlowConstant`](/api/classes/FlowConstant.md).[`disposed`](/api/classes/FlowConstant.md#disposed)
+
+## Methods
+
+### dispose()
+
+```ts
+dispose(options?): void;
+```
+
+Defined in: [basic/signal.ts:69](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/signal.ts#L69)
+
+Disposes the FlowSignal.
+Cleans up all registered effects, listeners, and dependencies.
+Once disposed, further usage of the signal will throw an error.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | \{ `self`: `boolean`; \} |
+| `options.self?` | `boolean` |
+
+#### Returns
+
+`void`
+
+#### Throws
+
+If the FlowSignal is already disposed.
+
+#### Inherited from
+
+[`FlowConstant`](/api/classes/FlowConstant.md).[`dispose`](/api/classes/FlowConstant.md#dispose)
+
+***
+
+### get()
+
+```ts
+get(context): T;
+```
+
+Defined in: [basic/observable.ts:47](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/observable.ts#L47)
+
+Gets the current value with optional dependency tracking.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `context` | [`TrackingContext`](/api/classes/TrackingContext.md) \| `null` | The tracking context for reactive tracking, or null for untracked access. When a context is provided, this observable is registered as a dependency. When null, the value is read without any tracking. |
+
+#### Returns
+
+`T`
+
+The current value of type T.
+
+#### Remarks
+
+Use `get(t)` within effects and derivations to create reactive dependencies.
+Use `get(null)` when you need to read a value without tracking (though `pick()` is more idiomatic).
+
+#### Example
+
+```typescript
+effect((t) => {
+  const tracked = $state.get(t);     // Dependency registered
+  const untracked = $other.get(null); // No dependency
+});
+```
+
+#### Inherited from
+
+[`FlowConstant`](/api/classes/FlowConstant.md).[`get`](/api/classes/FlowConstant.md#get)
+
+***
+
+### pick()
+
+```ts
+pick(): T;
+```
+
+Defined in: [basic/observable.ts:82](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/observable.ts#L82)
+
+Gets the current value without any dependency tracking.
+
+#### Returns
+
+`T`
+
+The current value of type T.
+
+#### Remarks
+
+This method is equivalent to calling `get(null)` but provides a more semantic and readable API.
+Use `pick()` when you want to read a snapshot of the current value without creating a reactive
+dependency. This is useful for:
+- Reading initial values
+- Accessing configuration that shouldn't trigger updates
+- Mixing tracked and untracked reads in the same effect
+
+#### Example
+
+```typescript
+// Read a snapshot outside reactive context
+const currentValue = $state.pick();
+
+// Mix tracked and untracked reads
+effect((t) => {
+  const tracked = $reactive.get(t);    // Triggers re-runs
+  const snapshot = $config.pick();     // Doesn't trigger re-runs
+  processData(tracked, snapshot);
+});
+```
+
+#### Inherited from
+
+[`FlowConstant`](/api/classes/FlowConstant.md).[`pick`](/api/classes/FlowConstant.md#pick)
+
+***
+
+### set()
+
+```ts
+set(value): void;
+```
+
+Defined in: [basic/state.ts:46](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/state.ts#L46)
+
+Updates the state with a new value.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `T` \| (`current`) => `T` | A new value or a callback function that computes a new value based on the current state. |
+
+#### Returns
+
+`void`
+
+#### Remarks
+
+If the computed new value is strictly equal to the current state value, no change is made and subscribers
+will not be notified. Otherwise, the state is updated and all subscribers are informed of the change.
+
+#### Throws
+
+Error if the state has been disposed.
+
+***
+
+### subscribe()
+
+```ts
+subscribe(listener): () => void;
+```
+
+Defined in: [basic/observable.ts:103](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/observable.ts#L103)
+
+Subscribes a listener function to changes of the observable.
+The listener is executed immediately with the current value and on subsequent updates.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `listener` | (`value`) => `void` | A callback function that receives the new value. |
+
+#### Returns
+
+A disposer function to cancel the subscription.
+
+```ts
+(): void;
+```
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+[`FlowConstant`](/api/classes/FlowConstant.md).[`subscribe`](/api/classes/FlowConstant.md#subscribe)
+
+***
+
+### trigger()
+
+```ts
+trigger(): void;
+```
+
+Defined in: [basic/signal.ts:19](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/signal.ts#L19)
+
+Triggers the FlowSignal.
+Notifies all registered listeners and schedules execution of associated effects.
+
+#### Returns
+
+`void`
+
+#### Throws
+
+If the FlowSignal has already been disposed.
+
+#### Inherited from
+
+[`FlowConstant`](/api/classes/FlowConstant.md).[`trigger`](/api/classes/FlowConstant.md#trigger)
+
+***
+
+### watch()
+
+```ts
+watch(context): void;
+```
+
+Defined in: [basic/signal.ts:57](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/signal.ts#L57)
+
+Watches the signal, registering it as a dependency in the tracking context.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `context` | [`TrackingContext`](/api/classes/TrackingContext.md) | The tracking context in which to register this signal as a dependency. |
+
+#### Returns
+
+`void`
+
+#### Remarks
+
+Use `watch()` when you want to track a signal without reading its value (signals don't
+have values to read). This is useful for triggering effects based on signal events
+without needing associated data.
+
+When the signal is triggered via `trigger()`, any effects or derivations that have
+watched this signal will automatically re-execute.
+
+This method must be called within an effect or derivation context where a TrackingContext
+is available. For observables (which hold values), use `.get(t)` instead, which both
+reads the value and watches for changes.
+
+#### Throws
+
+Error if the signal has been disposed.
+
+#### Example
+
+```typescript
+const $signal = signal();
+
+effect((t) => {
+  $signal.watch(t);  // Track the signal
+  console.log('Signal triggered!');
+});
+
+$signal.trigger(); // Logs: "Signal triggered!"
+```
+
+#### Inherited from
+
+[`FlowConstant`](/api/classes/FlowConstant.md).[`watch`](/api/classes/FlowConstant.md#watch)