types.TmuxEventStream

interface types.TmuxEventStream

interface [source] ¶

interface [source] ¶

interface types.TmuxEventStream

A live stream of tmux control-mode events.

Async iterable and async disposable, so await using ends the connection on scope exit even when the loop throws. The events are consumed, not replayed, so a stream is iterated once.

Members

• [Symbol.asyncDispose] method
• close method End the connection. Safe to call more than once.
• dropped property Events discarded because the consumer fell behind.
• find method Resolve with the first event matches accepts, or undefined if the deadline passes or the stream is closed first.
• ready method Resolve once tmux has accepted the current attach, or reject with its reason.