@beignet/provider-event-bus-memory 0.0.20 → 0.0.22
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/CHANGELOG.md +8 -0
- package/README.md +23 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -76,6 +76,13 @@ export const server = await createNextServer({
|
|
|
76
76
|
Use `createInMemoryEventBus()` directly when you want to manually assign an
|
|
77
77
|
event bus under `ports`.
|
|
78
78
|
|
|
79
|
+
The provider contributes `ctx.ports.eventBus`, the standard Beignet
|
|
80
|
+
`EventBusPort`. It has no provider-specific escape hatch.
|
|
81
|
+
|
|
82
|
+
This package is optional by provider metadata. `beignet doctor --strict` treats
|
|
83
|
+
an installed-but-unregistered memory event bus as an informational hint rather
|
|
84
|
+
than a required production provider.
|
|
85
|
+
|
|
79
86
|
## Instrumentation
|
|
80
87
|
|
|
81
88
|
Pass a provider instrumentation target when creating the direct event bus to
|
|
@@ -87,6 +94,9 @@ const eventBus = createInMemoryEventBus({
|
|
|
87
94
|
});
|
|
88
95
|
```
|
|
89
96
|
|
|
97
|
+
Provider instrumentation records published event names under the `eventBus`
|
|
98
|
+
watcher. Payloads are not recorded.
|
|
99
|
+
|
|
90
100
|
## Using in use cases
|
|
91
101
|
|
|
92
102
|
```typescript
|
|
@@ -215,6 +225,19 @@ describe("User Registration", () => {
|
|
|
215
225
|
- **Error handling**: Handler errors reject `publish(...)` unless
|
|
216
226
|
`onHandlerError` is configured
|
|
217
227
|
|
|
228
|
+
## Local and tests
|
|
229
|
+
|
|
230
|
+
Use this provider for local development, deterministic use-case tests, and
|
|
231
|
+
single-process demos. Prefer it over a durable broker in tests unless the test
|
|
232
|
+
is specifically proving retry, delivery, or worker behavior.
|
|
233
|
+
|
|
234
|
+
## Deployment notes
|
|
235
|
+
|
|
236
|
+
Use the memory event bus only when in-process, best-effort delivery is
|
|
237
|
+
acceptable. For multi-process or production workflows that must survive
|
|
238
|
+
crashes, publish through Beignet outbox/listener workflows or implement
|
|
239
|
+
`EventBusPort` over a durable broker.
|
|
240
|
+
|
|
218
241
|
## When to use
|
|
219
242
|
|
|
220
243
|
Good for:
|
package/package.json
CHANGED