ConnectedServer.waitFor
Resolve once the server satisfies matches, or reject on timeout.
Source and package
- Qualified name
-
ConnectedServer. wait For - Module
- types
- Declared in
ConnectedServer- Package
- libtmux
- Source
- packages/libtmux/src/types.ts
- waitFor( matches: (snapshot: Server
Snapshot ) => boolean, options?: WaitFor , ): Promise<ServerOptions Snapshot > -
Description#
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" }));- Parameters
-
-
matches((snapshot: ServerSnapshot ) => boolean) #
-
- Raises
-
-
Wait
Timeout – when the deadline passes with the condition unmet.Error -
Lib
Tmux – when the connection ends first, which says nothing about the condition and so is not the same answer.Error
-
Guides#
Pages that discuss waitFor.