@workglow/task-graph 0.2.16 → 0.2.18
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.
- package/README.md +8 -3
- package/dist/browser.js +212 -102
- package/dist/browser.js.map +16 -13
- package/dist/bun.js +212 -102
- package/dist/bun.js.map +16 -13
- package/dist/common.d.ts +3 -0
- package/dist/common.d.ts.map +1 -1
- package/dist/node.js +212 -102
- package/dist/node.js.map +16 -13
- package/dist/refcountable.d.ts +29 -0
- package/dist/refcountable.d.ts.map +1 -0
- package/dist/storage/PortCodecRegistry.d.ts +8 -0
- package/dist/storage/PortCodecRegistry.d.ts.map +1 -0
- package/dist/task/FallbackTaskRunner.d.ts +2 -2
- package/dist/task/FallbackTaskRunner.d.ts.map +1 -1
- package/dist/task/GraphAsTaskRunner.d.ts +5 -5
- package/dist/task/GraphAsTaskRunner.d.ts.map +1 -1
- package/dist/task/ITask.d.ts +3 -3
- package/dist/task/ITask.d.ts.map +1 -1
- package/dist/task/ITaskRunner.d.ts +2 -2
- package/dist/task/ITaskRunner.d.ts.map +1 -1
- package/dist/task/InputResolver.d.ts.map +1 -1
- package/dist/task/IteratorTaskRunner.d.ts +4 -3
- package/dist/task/IteratorTaskRunner.d.ts.map +1 -1
- package/dist/task/Task.d.ts +8 -9
- package/dist/task/Task.d.ts.map +1 -1
- package/dist/task/TaskRunner.d.ts +9 -9
- package/dist/task/TaskRunner.d.ts.map +1 -1
- package/dist/task/WhileTaskRunner.d.ts +2 -2
- package/dist/task/WhileTaskRunner.d.ts.map +1 -1
- package/dist/task-graph/ITaskGraph.d.ts +1 -1
- package/dist/task-graph/ITaskGraph.d.ts.map +1 -1
- package/dist/task-graph/TaskGraph.d.ts +3 -3
- package/dist/task-graph/TaskGraph.d.ts.map +1 -1
- package/dist/task-graph/TaskGraphRunner.d.ts +13 -13
- package/dist/task-graph/TaskGraphRunner.d.ts.map +1 -1
- package/package.json +7 -7
- package/src/EXECUTION_MODEL.md +132 -74
- package/src/task/README.md +5 -4
- package/src/task-graph/README.md +1 -1
- package/dist/__tests__/public-exports.test.d.ts +0 -7
- package/dist/__tests__/public-exports.test.d.ts.map +0 -1
package/README.md
CHANGED
|
@@ -138,7 +138,8 @@ console.log(second); // { result: 60 }
|
|
|
138
138
|
Tasks are the fundamental units of work. Each task:
|
|
139
139
|
|
|
140
140
|
- Defines input/output schemas using JSON Schema (from `@workglow/util`), TypeBox, or Zod
|
|
141
|
-
- Implements `execute()` for main logic
|
|
141
|
+
- Implements `execute()` for main logic; optionally `executePreview()` for fast UI previews
|
|
142
|
+
(called only by `runPreview()`, never as part of `run()`)
|
|
142
143
|
- Has a unique type identifier and category
|
|
143
144
|
- Can be cached based on inputs
|
|
144
145
|
- Emits lifecycle events
|
|
@@ -1109,9 +1110,13 @@ Format is also used on array types, e.g., `format: 'Float64Array'` on arrays con
|
|
|
1109
1110
|
|
|
1110
1111
|
#### Task
|
|
1111
1112
|
|
|
1112
|
-
- `run(overrides?)`: Execute the task with optional input overrides
|
|
1113
|
-
- `
|
|
1113
|
+
- `run(overrides?)`: Execute the task with optional input overrides (calls `execute()` / `executeStream()`)
|
|
1114
|
+
- `runPreview(overrides?)`: Run the preview-only path (calls `executePreview()` only)
|
|
1114
1115
|
- `abort()`: Cancel execution
|
|
1116
|
+
|
|
1117
|
+
`run()` and `runPreview()` are strictly orthogonal: `run()` never invokes `executePreview()`,
|
|
1118
|
+
and `runPreview()` never invokes `execute()` or `executeStream()`. There is no post-execute
|
|
1119
|
+
overlay; cache hits during `run()` return the cached value verbatim.
|
|
1115
1120
|
- `setInput(input)`: Set input values
|
|
1116
1121
|
- `validateInput(input)`: Validate input against schema
|
|
1117
1122
|
|