Skip to content

Commit f824a28

Browse files
committed
Add a bit more info on the worker process
1 parent 7c6fb84 commit f824a28

2 files changed

Lines changed: 16 additions & 1 deletion

File tree

docs/pages/cli.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,16 @@ To manage your subscriptions there are the following cli commands.
4343
!!! note
4444

4545
You can find out more about subscriptions [here](subscription.md).
46-
46+
47+
## Basic workflow for the worker
48+
49+
Use `event-sourcing:subscription:boot --setup` to first run the setup of any new subscriptions
50+
and immediately boot them.
51+
52+
The `event-sourcing:subscription:run` command will continue to run and process new events
53+
until the process is killed. After adding a new subscriber and booting it, you should
54+
restart the `run` command.
55+
4756
## Inspector commands
4857

4958
The inspector is a tool to inspect the event streams.

docs/pages/subscription.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1184,6 +1184,12 @@ $catchupSubscriptionEngine = new CatchUpSubscriptionEngine($subscriptionEngine);
11841184
!!! tip
11851185

11861186
You can use the `CatchUpSubscriptionEngine` in your tests to process the events immediately.
1187+
1188+
!!! Note
1189+
1190+
Learn more about the worker [here](./cli.md#subscription-commands).
1191+
1192+
## Subscription Lifecycle
11871193

11881194
### Throw on error Subscription Engine
11891195

0 commit comments

Comments
 (0)