shumengya/sproutclaw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(coding-agent): fix event bus docs - handlers persist, remove redundant note

Browse Source
This commit is contained in:
Mario Zechner
2026-01-04 21:39:13 +01:00
parent 99a539baa4
commit 024ec33bf2
2 changed files with 2 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/coding-agent/docs/custom-tools.md
View File

@@ -200,9 +200,7 @@ const unsubscribe = pi.events.on("other:event", (data) => {
}); });
``` ```
Events are session-scoped. Use namespaced channel names like `"toolname:event"` to avoid collisions. Event handlers persist across session switches (registered once at tool load time). Use namespaced channel names like `"toolname:event"` to avoid collisions. Handler errors (sync and async) are caught and logged.
Handler errors (sync and async) are caught and logged.
### Sending Messages ### Sending Messages

6
packages/coding-agent/docs/hooks.md
View File

@@ -904,11 +904,7 @@ const unsubscribe = pi.events.on("my:channel", handler);
unsubscribe(); unsubscribe();
``` ```
Events are session-scoped (cleared when session ends). Channel names are arbitrary strings - use namespaced names like `"toolname:event"` to avoid collisions. Event handlers persist across session switches (registered once at hook load time). Channel names are arbitrary strings; use namespaced names like `"toolname:event"` to avoid collisions. Handler errors (sync and async) are caught and logged.
Handler errors (sync and async) are caught and logged.
**Important:** Use `{ triggerTurn: true }` when you want the agent to respond to the event. Without it, the message displays but the agent stays idle.
## Examples ## Examples