Pane.waitForText
LibTmux.FSharp Waits for a line the pane prints to contain the text.
Source and package
- Module
- LibTmux.FSharp
- Declared in
- Pane
- Package
- LibTmux.FSharp
- Source
- src/LibTmux.FSharp/Hierarchy.fsi
- F# value signatures Declares the name and type of a value or function in a signature. Language documentation waitForText: cancellationToken: Cancellation
Token -> timeout: TimeSpan -> text: string -> pane: LibTmux -> Task<Pane.Pane Wait >Result -
Description#
Text already on screen ends the wait at once as <c>PresentAtEntry</c>. The wait sleeps on the pane's own output rather than polling, and ends early when the pane's program exits or a full-screen program starts. Running out of time returns the outcome <c>TimedOut</c>; only <c>Mirror.waitUntil</c> raises instead.
- Parameters
-
-
cancellationToken ( Cancellation
Token ) -
timeout ( TimeSpan )
-
text ( string )
-
pane ( Lib
Tmux ).Pane
-
- Raises
-
-
System
.Argument – The text is empty or spans lines.Exception -
Lib
Tmux – The pane's program had already exited..Tmux Pane Exception -
Lib
Tmux – tmux no longer has the pane..Tmux Object Not Found Exception
-
Discussed in Getting started , Streams and cleanup