@basaltkit/queue-kafka 1.1.1 → 1.1.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.
- package/README.md +16 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -72,6 +72,22 @@ await Job.dispatch(payload, { delay: '5m' }) // → throws UnsupportedJobOptionE
|
|
|
72
72
|
|
|
73
73
|
**If what you need is *streaming*/pub-sub** (rather than jobs with retry/delay), the natural fit in Basalt is usually `@basaltkit/events`, not `@basaltkit/queue`.
|
|
74
74
|
|
|
75
|
+
### Inspection: no `list()` / `queue:jobs`
|
|
76
|
+
|
|
77
|
+
This driver deliberately does **not** implement the queue's optional
|
|
78
|
+
`list(queue, options)` capability, so `basalt queue:jobs` reports it as
|
|
79
|
+
unsupported.
|
|
80
|
+
|
|
81
|
+
Here the reason is not destructiveness — reading a Kafka topic does not remove
|
|
82
|
+
records — but **meaning**. Kafka has no per-message state: there is no
|
|
83
|
+
`waiting`/`active`/`completed`/`failed` set, no broker-assigned job id, and no
|
|
84
|
+
way to tell a record still to be processed from one processed an hour ago. A
|
|
85
|
+
`list()` would return an arbitrary window of the log within retention, dressed
|
|
86
|
+
up in job states it invented. That would make the same API mean something
|
|
87
|
+
different depending on the driver, which is the coupling this API exists to
|
|
88
|
+
remove. Use your Kafka tooling (`kafka-console-consumer`, a UI) plus the
|
|
89
|
+
`<topic>.retry` / `<topic>.dead` topics instead.
|
|
90
|
+
|
|
75
91
|
## How it works
|
|
76
92
|
|
|
77
93
|
For each queue `t`:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@basaltkit/queue-kafka",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.3",
|
|
4
4
|
"engines": {
|
|
5
5
|
"node": ">=22.5.0"
|
|
6
6
|
},
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"dist"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@basaltkit/queue": "^
|
|
21
|
+
"@basaltkit/queue": "^2.0.0"
|
|
22
22
|
},
|
|
23
23
|
"peerDependencies": {
|
|
24
24
|
"kafkajs": "^2.0.0"
|