Skip to content

Commit 2c59e91

Browse files
committed
[docs]: comments for new type
1 parent 1bd4020 commit 2c59e91

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

Workflow/Sources/WorkflowNode.swift

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,8 +202,17 @@ extension WorkflowNode {
202202
// MARK: - Action Application
203203

204204
extension WorkflowNode {
205+
/// Represents the result of applying a `WorkflowAction` to a workflow's state.
205206
struct ActionApplicationResult {
207+
/// An optional output event produced by the action application.
208+
/// This will be propagated up the workflow hierarchy if present.
206209
var output: WorkflowType.Output?
210+
211+
/// Indicates whether the node's state was modified during action application.
212+
/// This is used to determine if the node needs to be re-rendered and to
213+
/// track invalidation through the workflow hierarchy. Note that currently this
214+
/// value does not definitively indicate if the state actually changed, but should
215+
/// be treated as a 'dirty bit' flag – if it's set, the node should be re-rendered.
207216
var stateChanged: Bool
208217
}
209218

0 commit comments

Comments
 (0)