# types.TmuxEventStream

- **Module:** types
- **Package:** libtmux
- **Language:** TypeScript
- **Kind:** interface
- **Source:** https://github.com/libtmux/libtmux-ts/blob/3fe1ca654b81b8cbf4a13b777a001a3298c87a6f/packages/libtmux/src/types.ts#L880
- **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

- `close` (method): End the connection. Safe to call more than once.
- `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.
- `dropped` (property): Events discarded because the consumer fell behind.
- `[Symbol.asyncDispose]` (method)