@ersbeth/picoflow 2.0.2 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/README.md +10 -0
  2. package/SKILL.md +106 -0
  3. package/package.json +5 -1
  4. package/.gitlab-ci.yml +0 -24
  5. package/.vscode/settings.json +0 -5
  6. package/CHANGELOG.md +0 -94
  7. package/biome.json +0 -47
  8. package/docs/.vitepress/config.mts +0 -145
  9. package/docs/api/functions/array.md +0 -35
  10. package/docs/api/functions/constant.md +0 -33
  11. package/docs/api/functions/constantAsync.md +0 -69
  12. package/docs/api/functions/derivation.md +0 -34
  13. package/docs/api/functions/derivationAsync.md +0 -34
  14. package/docs/api/functions/from.md +0 -129
  15. package/docs/api/functions/isDisposable.md +0 -27
  16. package/docs/api/functions/map.md +0 -36
  17. package/docs/api/functions/signal.md +0 -21
  18. package/docs/api/functions/state.md +0 -67
  19. package/docs/api/functions/stateAsync.md +0 -69
  20. package/docs/api/functions/subscribe.md +0 -40
  21. package/docs/api/functions/writableDerivation.md +0 -33
  22. package/docs/api/functions/writableDerivationAsync.md +0 -34
  23. package/docs/api/index.md +0 -61
  24. package/docs/api/interfaces/FlowArray.md +0 -439
  25. package/docs/api/interfaces/FlowConstant.md +0 -220
  26. package/docs/api/interfaces/FlowConstantAsync.md +0 -221
  27. package/docs/api/interfaces/FlowDerivation.md +0 -241
  28. package/docs/api/interfaces/FlowDerivationAsync.md +0 -242
  29. package/docs/api/interfaces/FlowDisposable.md +0 -59
  30. package/docs/api/interfaces/FlowEffect.md +0 -64
  31. package/docs/api/interfaces/FlowMap.md +0 -374
  32. package/docs/api/interfaces/FlowObservable.md +0 -155
  33. package/docs/api/interfaces/FlowSignal.md +0 -156
  34. package/docs/api/interfaces/FlowState.md +0 -269
  35. package/docs/api/interfaces/FlowStateAsync.md +0 -268
  36. package/docs/api/interfaces/FlowSubscribable.md +0 -55
  37. package/docs/api/interfaces/FlowTracker.md +0 -61
  38. package/docs/api/interfaces/FlowValue.md +0 -222
  39. package/docs/api/interfaces/FlowWritableDerivation.md +0 -292
  40. package/docs/api/interfaces/FlowWritableDerivationAsync.md +0 -293
  41. package/docs/api/type-aliases/DerivationFunction.md +0 -28
  42. package/docs/api/type-aliases/DerivationFunctionAsync.md +0 -28
  43. package/docs/api/type-aliases/FlowArrayAction.md +0 -60
  44. package/docs/api/type-aliases/FlowDataTracker.md +0 -33
  45. package/docs/api/type-aliases/FlowMapAction.md +0 -48
  46. package/docs/api/type-aliases/FlowOnDataListener.md +0 -33
  47. package/docs/api/type-aliases/FlowOnErrorListener.md +0 -27
  48. package/docs/api/type-aliases/FlowOnPendingListener.md +0 -21
  49. package/docs/api/type-aliases/FlowReadonly.md +0 -22
  50. package/docs/api/type-aliases/InitFunction.md +0 -21
  51. package/docs/api/type-aliases/InitFunctionAsync.md +0 -21
  52. package/docs/api/type-aliases/NotPromise.md +0 -21
  53. package/docs/api/type-aliases/UpdateFunction.md +0 -27
  54. package/docs/api/type-aliases/UpdateFunctionAsync.md +0 -27
  55. package/docs/api/typedoc-sidebar.json +0 -65
  56. package/docs/examples/examples.md +0 -2311
  57. package/docs/examples/patterns.md +0 -649
  58. package/docs/guide/advanced/architecture.md +0 -1234
  59. package/docs/guide/advanced/disposal.md +0 -426
  60. package/docs/guide/advanced/migration-v1.md +0 -464
  61. package/docs/guide/advanced/migration-v2.md +0 -204
  62. package/docs/guide/advanced/solidjs.md +0 -135
  63. package/docs/guide/introduction/concepts.md +0 -57
  64. package/docs/guide/introduction/conventions.md +0 -30
  65. package/docs/guide/introduction/getting-started.md +0 -139
  66. package/docs/guide/introduction/lifecycle.md +0 -368
  67. package/docs/guide/primitives/array.md +0 -286
  68. package/docs/guide/primitives/constant.md +0 -207
  69. package/docs/guide/primitives/derivations.md +0 -281
  70. package/docs/guide/primitives/effects.md +0 -372
  71. package/docs/guide/primitives/map.md +0 -265
  72. package/docs/guide/primitives/overview.md +0 -92
  73. package/docs/guide/primitives/signal.md +0 -222
  74. package/docs/guide/primitives/state.md +0 -272
  75. package/docs/index.md +0 -47
  76. package/docs/public/logo.svg +0 -1
  77. package/src/api/base/flowDisposable.ts +0 -44
  78. package/src/api/base/flowObservable.ts +0 -28
  79. package/src/api/base/flowSubscribable.ts +0 -87
  80. package/src/api/base/flowTracker.ts +0 -7
  81. package/src/api/base/index.ts +0 -4
  82. package/src/api/index.ts +0 -2
  83. package/src/api/nodes/async/flowConstantAsync.ts +0 -36
  84. package/src/api/nodes/async/flowDerivationAsync.ts +0 -42
  85. package/src/api/nodes/async/flowStateAsync.ts +0 -47
  86. package/src/api/nodes/async/flowWritableDerivationAsync.ts +0 -33
  87. package/src/api/nodes/async/index.ts +0 -4
  88. package/src/api/nodes/collections/flowArray.ts +0 -155
  89. package/src/api/nodes/collections/flowMap.ts +0 -115
  90. package/src/api/nodes/collections/index.ts +0 -2
  91. package/src/api/nodes/flowEffect.ts +0 -42
  92. package/src/api/nodes/flowSignal.ts +0 -28
  93. package/src/api/nodes/flowValue.ts +0 -37
  94. package/src/api/nodes/index.ts +0 -7
  95. package/src/api/nodes/sync/flowConstant.ts +0 -33
  96. package/src/api/nodes/sync/flowDerivation.ts +0 -41
  97. package/src/api/nodes/sync/flowState.ts +0 -45
  98. package/src/api/nodes/sync/flowWritableDerivation.ts +0 -31
  99. package/src/api/nodes/sync/index.ts +0 -4
  100. package/src/api/nodes/utils.ts +0 -24
  101. package/src/base/disposable.ts +0 -18
  102. package/src/base/executionStack.ts +0 -42
  103. package/src/base/index.ts +0 -5
  104. package/src/base/node.ts +0 -98
  105. package/src/base/observable.ts +0 -92
  106. package/src/base/observer.ts +0 -51
  107. package/src/converters/index.ts +0 -1
  108. package/src/converters/solid.ts +0 -109
  109. package/src/index.ts +0 -2
  110. package/src/nodes/arrayNode.ts +0 -180
  111. package/src/nodes/effectNode.ts +0 -58
  112. package/src/nodes/index.ts +0 -7
  113. package/src/nodes/mapNode.ts +0 -125
  114. package/src/nodes/signalNode.ts +0 -19
  115. package/src/nodes/valueAsyncNode.ts +0 -85
  116. package/src/nodes/valueNode.ts +0 -148
  117. package/src/nodes/valueSyncNode.ts +0 -125
  118. package/src/schedulers/asyncResolver.ts +0 -78
  119. package/src/schedulers/asyncScheduler.ts +0 -66
  120. package/src/schedulers/index.ts +0 -4
  121. package/src/schedulers/pendingError.ts +0 -13
  122. package/src/schedulers/scheduler.ts +0 -9
  123. package/src/schedulers/syncResolver.ts +0 -69
  124. package/src/schedulers/syncScheduler.ts +0 -55
  125. package/test/base/pendingError.test.ts +0 -67
  126. package/test/converters/solid.derivation.browser.test.tsx +0 -69
  127. package/test/converters/solid.node.test.ts +0 -654
  128. package/test/converters/solid.state.browser.test.tsx +0 -1592
  129. package/test/reactivity/flowSignal.test.ts +0 -226
  130. package/test/reactivity/nodes/async/asyncScheduler/asyncResolver.test.ts +0 -593
  131. package/test/reactivity/nodes/async/asyncScheduler/asyncScheduler.test.ts +0 -317
  132. package/test/reactivity/nodes/async/flowConstantAsync.test.ts +0 -652
  133. package/test/reactivity/nodes/async/flowDerivation.test.ts +0 -898
  134. package/test/reactivity/nodes/async/flowDerivationAsync.test.ts +0 -1716
  135. package/test/reactivity/nodes/async/flowStateAsync.test.ts +0 -708
  136. package/test/reactivity/nodes/async/flowWritableDerivationAsync.test.ts +0 -614
  137. package/test/reactivity/nodes/collections/flowArray.asyncStates.test.ts +0 -1289
  138. package/test/reactivity/nodes/collections/flowArray.scalars.test.ts +0 -961
  139. package/test/reactivity/nodes/collections/flowArray.states.test.ts +0 -1035
  140. package/test/reactivity/nodes/collections/flowMap.asyncStates.test.ts +0 -960
  141. package/test/reactivity/nodes/collections/flowMap.scalars.test.ts +0 -775
  142. package/test/reactivity/nodes/collections/flowMap.states.test.ts +0 -958
  143. package/test/reactivity/nodes/sync/flowConstant.test.ts +0 -377
  144. package/test/reactivity/nodes/sync/flowDerivation.test.ts +0 -896
  145. package/test/reactivity/nodes/sync/flowState.test.ts +0 -341
  146. package/test/reactivity/nodes/sync/flowWritableDerivation.test.ts +0 -603
  147. package/test/vitest.d.ts +0 -10
  148. package/tsconfig.json +0 -37
  149. package/typedoc.json +0 -37
  150. package/vite.config.ts +0 -31
  151. package/vitest.browser.config.ts +0 -21
  152. package/vitest.config.ts +0 -17
@@ -1,156 +0,0 @@
1
- [@ersbeth/picoflow](/api/index.md) / FlowSignal
2
-
3
- # Interface: FlowSignal
4
-
5
- Defined in: [api/nodes/flowSignal.ts:13](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowSignal.ts#L13)
6
-
7
- Manual trigger that notifies subscribers without carrying data.
8
-
9
- Unlike reactive state or derivations, signals don't hold values. They serve as event emitters
10
- that notify dependents when explicitly triggered. Use signals for side effects that should run
11
- in response to manual actions rather than data changes.
12
-
13
- ## Extends
14
-
15
- - [`FlowObservable`](/api/interfaces/FlowObservable.md)\<`void`\>
16
-
17
- ## Accessors
18
-
19
- ### disposed
20
-
21
- #### Get Signature
22
-
23
- ```ts
24
- get disposed(): boolean;
25
- ```
26
-
27
- Defined in: [api/base/flowDisposable.ts:17](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L17)
28
-
29
- Indicates whether this resource has been disposed.
30
-
31
- Returns `true` if `dispose()` has been called, `false` otherwise. Once disposed,
32
- the resource is no longer usable and any operations on it will throw errors.
33
-
34
- ##### Returns
35
-
36
- `boolean`
37
-
38
- #### Inherited from
39
-
40
- [`FlowObservable`](/api/interfaces/FlowObservable.md).[`disposed`](/api/interfaces/FlowObservable.md#disposed)
41
-
42
- ## Methods
43
-
44
- ### dispose()
45
-
46
- ```ts
47
- dispose(): void;
48
- ```
49
-
50
- Defined in: [api/base/flowDisposable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L27)
51
-
52
- Releases all resources held by this disposable object.
53
-
54
- Cleans up all subscriptions, dependencies, and internal state. After calling this method,
55
- the resource enters a disposed state and cannot be reused. Any subsequent operations will
56
- throw errors. This method should be called when you no longer need the reactive primitive
57
- to prevent memory leaks.
58
-
59
- #### Returns
60
-
61
- `void`
62
-
63
- #### Inherited from
64
-
65
- [`FlowObservable`](/api/interfaces/FlowObservable.md).[`dispose`](/api/interfaces/FlowObservable.md#dispose)
66
-
67
- ***
68
-
69
- ### subscribe()
70
-
71
- ```ts
72
- subscribe(
73
- onData,
74
- onError?,
75
- onPending?): FlowEffect;
76
- ```
77
-
78
- Defined in: [api/base/flowSubscribable.ts:82](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowSubscribable.ts#L82)
79
-
80
- Subscribes to this observable with lifecycle callbacks.
81
-
82
- Creates an active subscription that executes immediately and then re-executes whenever
83
- the observable's dependencies change. The subscription remains active until the returned
84
- disposal function is called. The `onData` callback receives the computed value, while
85
- `onError` handles errors and `onPending` signals async operations in progress.
86
-
87
- #### Parameters
88
-
89
- | Parameter | Type | Description |
90
- | ------ | ------ | ------ |
91
- | `onData` | [`FlowOnDataListener`](/api/type-aliases/FlowOnDataListener.md)\<`void`\> | Callback invoked with the computed data on each execution |
92
- | `onError?` | [`FlowOnErrorListener`](/api/type-aliases/FlowOnErrorListener.md) | Optional callback for handling errors during execution |
93
- | `onPending?` | [`FlowOnPendingListener`](/api/type-aliases/FlowOnPendingListener.md) | Optional callback invoked when async dependencies are pending |
94
-
95
- #### Returns
96
-
97
- [`FlowEffect`](/api/interfaces/FlowEffect.md)
98
-
99
- A function to dispose the subscription and stop receiving updates
100
-
101
- #### Inherited from
102
-
103
- [`FlowObservable`](/api/interfaces/FlowObservable.md).[`subscribe`](/api/interfaces/FlowObservable.md#subscribe)
104
-
105
- ***
106
-
107
- ### trigger()
108
-
109
- ```ts
110
- trigger(): void;
111
- ```
112
-
113
- Defined in: [api/base/flowObservable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L27)
114
-
115
- Manually triggers notifications to all dependents.
116
-
117
- Forces all dependents of this observable to be notified and re-executed, even if the
118
- value hasn't actually changed. Useful for imperatively triggering updates when the
119
- reactive system cannot detect changes automatically.
120
-
121
- #### Returns
122
-
123
- `void`
124
-
125
- #### Inherited from
126
-
127
- [`FlowObservable`](/api/interfaces/FlowObservable.md).[`trigger`](/api/interfaces/FlowObservable.md#trigger)
128
-
129
- ***
130
-
131
- ### watch()
132
-
133
- ```ts
134
- watch(tracker): void;
135
- ```
136
-
137
- Defined in: [api/base/flowObservable.ts:18](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L18)
138
-
139
- Establishes a reactive dependency without reading the value.
140
-
141
- Registers this observable as a dependency of the given tracker, allowing it to be notified
142
- when changes occur. This enables dependency tracking without accessing the actual value.
143
-
144
- #### Parameters
145
-
146
- | Parameter | Type | Description |
147
- | ------ | ------ | ------ |
148
- | `tracker` | [`FlowTracker`](/api/interfaces/FlowTracker.md) | Tracker that records this observable as a dependency |
149
-
150
- #### Returns
151
-
152
- `void`
153
-
154
- #### Inherited from
155
-
156
- [`FlowObservable`](/api/interfaces/FlowObservable.md).[`watch`](/api/interfaces/FlowObservable.md#watch)
@@ -1,269 +0,0 @@
1
- [@ersbeth/picoflow](/api/index.md) / FlowState
2
-
3
- # Interface: FlowState\<T\>
4
-
5
- Defined in: [api/nodes/sync/flowState.ts:18](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowState.ts#L18)
6
-
7
- Writable reactive value that can be updated manually and notifies dependents on changes.
8
-
9
- State is the simplest writable reactive primitive. Unlike derivations, it has no dependencies and never
10
- recomputes automatically - changes only occur when you explicitly call `set()`. Use state for user input,
11
- application state, or any data that changes imperatively. Changes propagate automatically to all dependents.
12
-
13
- ## Extends
14
-
15
- - [`FlowValue`](/api/interfaces/FlowValue.md)\<`T`\>
16
-
17
- ## Extended by
18
-
19
- - [`FlowArray`](/api/interfaces/FlowArray.md)
20
- - [`FlowMap`](/api/interfaces/FlowMap.md)
21
- - [`FlowWritableDerivation`](/api/interfaces/FlowWritableDerivation.md)
22
-
23
- ## Type Parameters
24
-
25
- | Type Parameter |
26
- | ------ |
27
- | `T` |
28
-
29
- ## Accessors
30
-
31
- ### disposed
32
-
33
- #### Get Signature
34
-
35
- ```ts
36
- get disposed(): boolean;
37
- ```
38
-
39
- Defined in: [api/base/flowDisposable.ts:17](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L17)
40
-
41
- Indicates whether this resource has been disposed.
42
-
43
- Returns `true` if `dispose()` has been called, `false` otherwise. Once disposed,
44
- the resource is no longer usable and any operations on it will throw errors.
45
-
46
- ##### Returns
47
-
48
- `boolean`
49
-
50
- #### Inherited from
51
-
52
- [`FlowValue`](/api/interfaces/FlowValue.md).[`disposed`](/api/interfaces/FlowValue.md#disposed)
53
-
54
- ## Methods
55
-
56
- ### dispose()
57
-
58
- ```ts
59
- dispose(): void;
60
- ```
61
-
62
- Defined in: [api/base/flowDisposable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L27)
63
-
64
- Releases all resources held by this disposable object.
65
-
66
- Cleans up all subscriptions, dependencies, and internal state. After calling this method,
67
- the resource enters a disposed state and cannot be reused. Any subsequent operations will
68
- throw errors. This method should be called when you no longer need the reactive primitive
69
- to prevent memory leaks.
70
-
71
- #### Returns
72
-
73
- `void`
74
-
75
- #### Inherited from
76
-
77
- [`FlowValue`](/api/interfaces/FlowValue.md).[`dispose`](/api/interfaces/FlowValue.md#dispose)
78
-
79
- ***
80
-
81
- ### get()
82
-
83
- ```ts
84
- get(tracker): T;
85
- ```
86
-
87
- Defined in: [api/nodes/flowValue.ts:24](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowValue.ts#L24)
88
-
89
- Gets the current value and establishes a reactive dependency.
90
-
91
- When called from within a reactive computation, this method registers the value as a dependency,
92
- ensuring the computation re-executes when the value changes. The value is computed on first access
93
- (if lazy) and then cached. For async values, throws PendingError while the value is resolving.
94
-
95
- #### Parameters
96
-
97
- | Parameter | Type | Description |
98
- | ------ | ------ | ------ |
99
- | `tracker` | [`FlowTracker`](/api/interfaces/FlowTracker.md) | Tracker that records this value as a dependency |
100
-
101
- #### Returns
102
-
103
- `T`
104
-
105
- The current value
106
-
107
- #### Inherited from
108
-
109
- [`FlowValue`](/api/interfaces/FlowValue.md).[`get`](/api/interfaces/FlowValue.md#get)
110
-
111
- ***
112
-
113
- ### pick()
114
-
115
- ```ts
116
- pick(): Promise<T>;
117
- ```
118
-
119
- Defined in: [api/nodes/flowValue.ts:35](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowValue.ts#L35)
120
-
121
- Asynchronously gets the current value without establishing a reactive dependency.
122
-
123
- This method reads the value non-reactively, meaning it won't trigger re-execution of the calling
124
- computation when the value changes. The value is computed on first access (if lazy) and then cached.
125
- For async values, the promise resolves once the value is available.
126
-
127
- #### Returns
128
-
129
- `Promise`\<`T`\>
130
-
131
- Promise that resolves with the current value
132
-
133
- #### Inherited from
134
-
135
- [`FlowValue`](/api/interfaces/FlowValue.md).[`pick`](/api/interfaces/FlowValue.md#pick)
136
-
137
- ***
138
-
139
- ### set()
140
-
141
- #### Call Signature
142
-
143
- ```ts
144
- set(value): void;
145
- ```
146
-
147
- Defined in: [api/nodes/sync/flowState.ts:25](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowState.ts#L25)
148
-
149
- Updates the state with a new value or via an updater function.
150
- Notifies all dependents after the update.
151
-
152
- ##### Parameters
153
-
154
- | Parameter | Type | Description |
155
- | ------ | ------ | ------ |
156
- | `value` | [`NotPromise`](/api/type-aliases/NotPromise.md)\<`T`\> | New value to set, or function that receives current value and returns new value |
157
-
158
- ##### Returns
159
-
160
- `void`
161
-
162
- #### Call Signature
163
-
164
- ```ts
165
- set(updater): void;
166
- ```
167
-
168
- Defined in: [api/nodes/sync/flowState.ts:26](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowState.ts#L26)
169
-
170
- ##### Parameters
171
-
172
- | Parameter | Type |
173
- | ------ | ------ |
174
- | `updater` | [`UpdateFunction`](/api/type-aliases/UpdateFunction.md)\<`T`\> |
175
-
176
- ##### Returns
177
-
178
- `void`
179
-
180
- ***
181
-
182
- ### subscribe()
183
-
184
- ```ts
185
- subscribe(
186
- onData,
187
- onError?,
188
- onPending?): FlowEffect;
189
- ```
190
-
191
- Defined in: [api/base/flowSubscribable.ts:82](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowSubscribable.ts#L82)
192
-
193
- Subscribes to this observable with lifecycle callbacks.
194
-
195
- Creates an active subscription that executes immediately and then re-executes whenever
196
- the observable's dependencies change. The subscription remains active until the returned
197
- disposal function is called. The `onData` callback receives the computed value, while
198
- `onError` handles errors and `onPending` signals async operations in progress.
199
-
200
- #### Parameters
201
-
202
- | Parameter | Type | Description |
203
- | ------ | ------ | ------ |
204
- | `onData` | [`FlowOnDataListener`](/api/type-aliases/FlowOnDataListener.md)\<`T`\> | Callback invoked with the computed data on each execution |
205
- | `onError?` | [`FlowOnErrorListener`](/api/type-aliases/FlowOnErrorListener.md) | Optional callback for handling errors during execution |
206
- | `onPending?` | [`FlowOnPendingListener`](/api/type-aliases/FlowOnPendingListener.md) | Optional callback invoked when async dependencies are pending |
207
-
208
- #### Returns
209
-
210
- [`FlowEffect`](/api/interfaces/FlowEffect.md)
211
-
212
- A function to dispose the subscription and stop receiving updates
213
-
214
- #### Inherited from
215
-
216
- [`FlowValue`](/api/interfaces/FlowValue.md).[`subscribe`](/api/interfaces/FlowValue.md#subscribe)
217
-
218
- ***
219
-
220
- ### trigger()
221
-
222
- ```ts
223
- trigger(): void;
224
- ```
225
-
226
- Defined in: [api/base/flowObservable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L27)
227
-
228
- Manually triggers notifications to all dependents.
229
-
230
- Forces all dependents of this observable to be notified and re-executed, even if the
231
- value hasn't actually changed. Useful for imperatively triggering updates when the
232
- reactive system cannot detect changes automatically.
233
-
234
- #### Returns
235
-
236
- `void`
237
-
238
- #### Inherited from
239
-
240
- [`FlowValue`](/api/interfaces/FlowValue.md).[`trigger`](/api/interfaces/FlowValue.md#trigger)
241
-
242
- ***
243
-
244
- ### watch()
245
-
246
- ```ts
247
- watch(tracker): void;
248
- ```
249
-
250
- Defined in: [api/base/flowObservable.ts:18](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L18)
251
-
252
- Establishes a reactive dependency without reading the value.
253
-
254
- Registers this observable as a dependency of the given tracker, allowing it to be notified
255
- when changes occur. This enables dependency tracking without accessing the actual value.
256
-
257
- #### Parameters
258
-
259
- | Parameter | Type | Description |
260
- | ------ | ------ | ------ |
261
- | `tracker` | [`FlowTracker`](/api/interfaces/FlowTracker.md) | Tracker that records this observable as a dependency |
262
-
263
- #### Returns
264
-
265
- `void`
266
-
267
- #### Inherited from
268
-
269
- [`FlowValue`](/api/interfaces/FlowValue.md).[`watch`](/api/interfaces/FlowValue.md#watch)
@@ -1,268 +0,0 @@
1
- [@ersbeth/picoflow](/api/index.md) / FlowStateAsync
2
-
3
- # Interface: FlowStateAsync\<T\>
4
-
5
- Defined in: [api/nodes/async/flowStateAsync.ts:19](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/async/flowStateAsync.ts#L19)
6
-
7
- Writable reactive value that resolves promises and can be updated with new promises.
8
-
9
- Async state is the async equivalent of regular state. Unlike sync state, it accepts promises instead of
10
- direct values. Set new promises or async updater functions to update the state. While a promise is pending,
11
- accessing the value throws PendingError. Use for async data that changes imperatively, such as user-triggered
12
- API calls, async form submissions, or any async operation that updates based on user actions.
13
-
14
- ## Extends
15
-
16
- - [`FlowValue`](/api/interfaces/FlowValue.md)\<`T`\>
17
-
18
- ## Extended by
19
-
20
- - [`FlowWritableDerivationAsync`](/api/interfaces/FlowWritableDerivationAsync.md)
21
-
22
- ## Type Parameters
23
-
24
- | Type Parameter |
25
- | ------ |
26
- | `T` |
27
-
28
- ## Accessors
29
-
30
- ### disposed
31
-
32
- #### Get Signature
33
-
34
- ```ts
35
- get disposed(): boolean;
36
- ```
37
-
38
- Defined in: [api/base/flowDisposable.ts:17](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L17)
39
-
40
- Indicates whether this resource has been disposed.
41
-
42
- Returns `true` if `dispose()` has been called, `false` otherwise. Once disposed,
43
- the resource is no longer usable and any operations on it will throw errors.
44
-
45
- ##### Returns
46
-
47
- `boolean`
48
-
49
- #### Inherited from
50
-
51
- [`FlowValue`](/api/interfaces/FlowValue.md).[`disposed`](/api/interfaces/FlowValue.md#disposed)
52
-
53
- ## Methods
54
-
55
- ### dispose()
56
-
57
- ```ts
58
- dispose(): void;
59
- ```
60
-
61
- Defined in: [api/base/flowDisposable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L27)
62
-
63
- Releases all resources held by this disposable object.
64
-
65
- Cleans up all subscriptions, dependencies, and internal state. After calling this method,
66
- the resource enters a disposed state and cannot be reused. Any subsequent operations will
67
- throw errors. This method should be called when you no longer need the reactive primitive
68
- to prevent memory leaks.
69
-
70
- #### Returns
71
-
72
- `void`
73
-
74
- #### Inherited from
75
-
76
- [`FlowValue`](/api/interfaces/FlowValue.md).[`dispose`](/api/interfaces/FlowValue.md#dispose)
77
-
78
- ***
79
-
80
- ### get()
81
-
82
- ```ts
83
- get(tracker): T;
84
- ```
85
-
86
- Defined in: [api/nodes/flowValue.ts:24](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowValue.ts#L24)
87
-
88
- Gets the current value and establishes a reactive dependency.
89
-
90
- When called from within a reactive computation, this method registers the value as a dependency,
91
- ensuring the computation re-executes when the value changes. The value is computed on first access
92
- (if lazy) and then cached. For async values, throws PendingError while the value is resolving.
93
-
94
- #### Parameters
95
-
96
- | Parameter | Type | Description |
97
- | ------ | ------ | ------ |
98
- | `tracker` | [`FlowTracker`](/api/interfaces/FlowTracker.md) | Tracker that records this value as a dependency |
99
-
100
- #### Returns
101
-
102
- `T`
103
-
104
- The current value
105
-
106
- #### Inherited from
107
-
108
- [`FlowValue`](/api/interfaces/FlowValue.md).[`get`](/api/interfaces/FlowValue.md#get)
109
-
110
- ***
111
-
112
- ### pick()
113
-
114
- ```ts
115
- pick(): Promise<T>;
116
- ```
117
-
118
- Defined in: [api/nodes/flowValue.ts:35](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowValue.ts#L35)
119
-
120
- Asynchronously gets the current value without establishing a reactive dependency.
121
-
122
- This method reads the value non-reactively, meaning it won't trigger re-execution of the calling
123
- computation when the value changes. The value is computed on first access (if lazy) and then cached.
124
- For async values, the promise resolves once the value is available.
125
-
126
- #### Returns
127
-
128
- `Promise`\<`T`\>
129
-
130
- Promise that resolves with the current value
131
-
132
- #### Inherited from
133
-
134
- [`FlowValue`](/api/interfaces/FlowValue.md).[`pick`](/api/interfaces/FlowValue.md#pick)
135
-
136
- ***
137
-
138
- ### set()
139
-
140
- #### Call Signature
141
-
142
- ```ts
143
- set(promise): void;
144
- ```
145
-
146
- Defined in: [api/nodes/async/flowStateAsync.ts:26](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/async/flowStateAsync.ts#L26)
147
-
148
- Updates the state with a new promise or via an async updater function.
149
- Notifies all dependents immediately (they will receive PendingError until resolved).
150
-
151
- ##### Parameters
152
-
153
- | Parameter | Type | Description |
154
- | ------ | ------ | ------ |
155
- | `promise` | `Promise`\<`T`\> | New promise to resolve, or async function that receives current value and returns a promise |
156
-
157
- ##### Returns
158
-
159
- `void`
160
-
161
- #### Call Signature
162
-
163
- ```ts
164
- set(updater): void;
165
- ```
166
-
167
- Defined in: [api/nodes/async/flowStateAsync.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/async/flowStateAsync.ts#L27)
168
-
169
- ##### Parameters
170
-
171
- | Parameter | Type |
172
- | ------ | ------ |
173
- | `updater` | [`UpdateFunctionAsync`](/api/type-aliases/UpdateFunctionAsync.md)\<`T`\> |
174
-
175
- ##### Returns
176
-
177
- `void`
178
-
179
- ***
180
-
181
- ### subscribe()
182
-
183
- ```ts
184
- subscribe(
185
- onData,
186
- onError?,
187
- onPending?): FlowEffect;
188
- ```
189
-
190
- Defined in: [api/base/flowSubscribable.ts:82](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowSubscribable.ts#L82)
191
-
192
- Subscribes to this observable with lifecycle callbacks.
193
-
194
- Creates an active subscription that executes immediately and then re-executes whenever
195
- the observable's dependencies change. The subscription remains active until the returned
196
- disposal function is called. The `onData` callback receives the computed value, while
197
- `onError` handles errors and `onPending` signals async operations in progress.
198
-
199
- #### Parameters
200
-
201
- | Parameter | Type | Description |
202
- | ------ | ------ | ------ |
203
- | `onData` | [`FlowOnDataListener`](/api/type-aliases/FlowOnDataListener.md)\<`T`\> | Callback invoked with the computed data on each execution |
204
- | `onError?` | [`FlowOnErrorListener`](/api/type-aliases/FlowOnErrorListener.md) | Optional callback for handling errors during execution |
205
- | `onPending?` | [`FlowOnPendingListener`](/api/type-aliases/FlowOnPendingListener.md) | Optional callback invoked when async dependencies are pending |
206
-
207
- #### Returns
208
-
209
- [`FlowEffect`](/api/interfaces/FlowEffect.md)
210
-
211
- A function to dispose the subscription and stop receiving updates
212
-
213
- #### Inherited from
214
-
215
- [`FlowValue`](/api/interfaces/FlowValue.md).[`subscribe`](/api/interfaces/FlowValue.md#subscribe)
216
-
217
- ***
218
-
219
- ### trigger()
220
-
221
- ```ts
222
- trigger(): void;
223
- ```
224
-
225
- Defined in: [api/base/flowObservable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L27)
226
-
227
- Manually triggers notifications to all dependents.
228
-
229
- Forces all dependents of this observable to be notified and re-executed, even if the
230
- value hasn't actually changed. Useful for imperatively triggering updates when the
231
- reactive system cannot detect changes automatically.
232
-
233
- #### Returns
234
-
235
- `void`
236
-
237
- #### Inherited from
238
-
239
- [`FlowValue`](/api/interfaces/FlowValue.md).[`trigger`](/api/interfaces/FlowValue.md#trigger)
240
-
241
- ***
242
-
243
- ### watch()
244
-
245
- ```ts
246
- watch(tracker): void;
247
- ```
248
-
249
- Defined in: [api/base/flowObservable.ts:18](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L18)
250
-
251
- Establishes a reactive dependency without reading the value.
252
-
253
- Registers this observable as a dependency of the given tracker, allowing it to be notified
254
- when changes occur. This enables dependency tracking without accessing the actual value.
255
-
256
- #### Parameters
257
-
258
- | Parameter | Type | Description |
259
- | ------ | ------ | ------ |
260
- | `tracker` | [`FlowTracker`](/api/interfaces/FlowTracker.md) | Tracker that records this observable as a dependency |
261
-
262
- #### Returns
263
-
264
- `void`
265
-
266
- #### Inherited from
267
-
268
- [`FlowValue`](/api/interfaces/FlowValue.md).[`watch`](/api/interfaces/FlowValue.md#watch)