TmuxEventStream
A live stream of tmux control-mode events.
Source and package
- Qualified name
-
TmuxEvent Stream - Module
- types
- Package
- libtmux
- Source
- packages/libtmux/src/types.ts
-
Description#
Async iterable and async disposable, so
await usingends the connection on scope exit even when the loop throws. The events are consumed, not replayed, so a stream is iterated once.
Members5#
- [Symbol.asyncDispose] method
- close method End the connection. Safe to call more than once.
- dropped: number property Events discarded because the consumer fell behind.
- find method Resolve with the first event
matchesaccepts, 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.