octaflow 0.20.0 → 0.20.1
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 +10 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -85,7 +85,7 @@ npx tsx scripts/demo.ts # reproduce it
|
|
|
85
85
|
## Contents
|
|
86
86
|
|
|
87
87
|
- [How it compares](#how-it-compares)
|
|
88
|
-
- [When not to use
|
|
88
|
+
- [When not to use it](#when-not-to-use-it)
|
|
89
89
|
- [Performance](#performance)
|
|
90
90
|
- [Features](#features)
|
|
91
91
|
- [Installation](#installation)
|
|
@@ -115,7 +115,7 @@ you already run Postgres, it adds no infrastructure — the queue ([pg-boss](htt
|
|
|
115
115
|
is Postgres too. You give up the dashboards, the polyglot SDKs, and the operational maturity
|
|
116
116
|
that the others have earned.
|
|
117
117
|
|
|
118
|
-
## When not to use
|
|
118
|
+
## When not to use it
|
|
119
119
|
|
|
120
120
|
Reach for something else if:
|
|
121
121
|
|
|
@@ -130,6 +130,14 @@ Reach for something else if:
|
|
|
130
130
|
([`toPublicWorkflow`](https://octaflow.octabits.io/extending/http/)) and lifecycle events, not a
|
|
131
131
|
dashboard. You build it.
|
|
132
132
|
- **You need non-TypeScript workers.** The DAG and its schemas are TypeScript values.
|
|
133
|
+
- **The caller is waiting.** Every step is a persisted transition, and in production a queue hop:
|
|
134
|
+
a step starts when a worker fetches it — on the next poll, unless `burstWhenBatchFull` is
|
|
135
|
+
keeping it busy — and adds engine time on top of your handler. Anything inside a
|
|
136
|
+
request/response — validate, transform, answer — is a function call. Put a workflow behind a
|
|
137
|
+
request only to *start* it, and let the page poll or subscribe for the outcome.
|
|
138
|
+
- **One job with retries.** A single step that must run later and try again is a queue job;
|
|
139
|
+
pg-boss on its own does that with less. A DAG earns its keep when steps depend on each other,
|
|
140
|
+
run in parallel, or must be resumed and read back.
|
|
133
141
|
- **You can't run Postgres**, or you need throughput past what a Postgres-backed queue gives you.
|
|
134
142
|
- **You need a support contract**, or an API frozen by a 1.0 promise. This is pre-1.0 and 0.x
|
|
135
143
|
minors can break.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "octaflow",
|
|
3
|
-
"version": "0.20.
|
|
3
|
+
"version": "0.20.1",
|
|
4
4
|
"description": "Durable DAG workflow engine: Zod-typed steps over Postgres + pg-boss, with an optional AI add-on (token/cost/quota). Layered single package.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|