Browse API 1 documentation
grove.typing()
Publish an IRC typing state.
Mango 3.1+View Markdown
Signature
ts
grove.typing(state: 'active' | 'paused' | 'done', options?: { to?: string; channel?: string }): void
Availability
IRC-bound runtimes with channel.send for a bound channel, query.send for a private target, or network.send for an explicit server-scoped channel.
Parameters
| Parameter | Required | Description |
|---|---|---|
state |
Yes | Exact lower-case active, paused, or done. |
options.to |
No | One existing private target. |
options.channel |
No | Confirmed joined channel, server scope only. |
Target validation follows grove.send(). Options cannot combine to and channel; server scope has no default destination. This method cannot open a query.
Return value
Returns undefined; no Promise or acknowledgement.
Behavior and errors
Unknown states, missing grants, and unsupported destinations are refused. Actual transmission depends on the IRC session’s support for typing notifications. Throttle updates in your UI and send done when composition ends.
Example
js
grove.typing('active')
// Later, when composition ends:
grove.typing('done')