Skip to content

Commit f4d1826

Browse files
committed
docs(chat): clarify non-blocking mailbox reads
1 parent b334ab2 commit f4d1826

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

docs/ai-chat/custom-agents.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,10 @@ message that `next()` can consume immediately. It does not query the remote
238238
Session channel or start a subscription. Use `waitWithIdleTimeout()` when the
239239
loop needs to idle until future input arrives.
240240

241+
`next({ timeoutInSeconds: 0 })` is also a local, non-blocking read. Call
242+
`next()` without a timeout, or with a positive timeout, to subscribe for future
243+
input.
244+
241245
`next()` returns a readonly record envelope:
242246

243247
```ts

0 commit comments

Comments
 (0)