# types.TmuxEventStream

- **Module:** types
- **Package:** libtmux
- **Language:** TypeScript
- **Kind:** interface
- **Source:** https://github.com/libtmux/libtmux-ts/blob/46cccfef2a546de55ce8b308249b8c76339089a0/packages/libtmux/src/types.ts#L990
- **Page:** https://libtmux.org/en/ts/latest/reference/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

### Other members

- [`[Symbol.asyncDispose]`](/en/ts/latest/reference/types-tmuxeventstream-[symbol-asyncdispose]/) (method)
- [`close`](/en/ts/latest/reference/types-tmuxeventstream-close/) (method): End the connection. Safe to call more than once.
- [`dropped`](/en/ts/latest/reference/types-tmuxeventstream-dropped/) (property): Events discarded because the consumer fell behind.
- [`find`](/en/ts/latest/reference/types-tmuxeventstream-find/) (method): Resolve with the first event `matches` accepts, or undefined if the deadline passes or the stream is closed first.
- [`ready`](/en/ts/latest/reference/types-tmuxeventstream-ready/) (method): Resolve once tmux has accepted the current attach, or reject with its reason.