types.ConnectedServer.waitFor
TypeScript
- Python Unavailable
- Ruby Unavailable
- Lua Unavailable
- TypeScript
- Rust Unavailable
- Go Unavailable
- Java Unavailable
- .NET Unavailable
- C++ Unavailable
- Swift Unavailable
- Module
- types
- Declared in
- ConnectedServer
- Package
- libtmux
- Source
- packages/libtmux/src/types.ts
- waitFor ( matches : : (snapshot: ServerSnapshot) => boolean , options : : WaitForOptions ) Promise<ServerSnapshot>
-
Resolve once the server satisfies
matches, or reject on timeout.This is the join between a snapshot and the stream: it subscribes first, then reads, so a change landing between those two steps is still seen. Doing it the other way round — read, then subscribe — waits forever on a condition that already came true. Notifications trigger immediate reads; bounded polling covers state changes tmux does not announce. An unannounced transition must persist until a sample to be observable.
Examples
await live.waitFor((server) => server.windows.exists({ name: "build" }));- Raises
-
-
WaitTimeoutError – when the deadline passes with the condition unmet.
-
LibTmuxError – when the connection ends first, which says nothing about the condition and so is not the same answer.
-
Discussed in Waiting and retrying
0 declared, 0 inherited