libtmux Reference MCP Search
On this page

types.TmuxEventStream.ready

View as Markdown

Module
types
Declared in
TmuxEventStream
Package
@libtmux/libtmux
Source
packages/libtmux/src/types.ts
ready ( ) Promise<void>
method [source]
method [source]
ready

Resolve once tmux has accepted the current attach, or reject with its reason.

A control client is told nothing that happened before it attached, so a change made between opening the stream and that moment is never announced to it. Await this before making the change you intend to observe, or the wait for it can outlive the event. During reconnect this waits for the replacement client, and rejects if the connection cannot recover.

0 declared, 0 inherited

Esc

Type to search.