Auto Light Dark

Core LibraryAPI Reference

Choose documentation 1

latest

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

F# API

function libtmux-fsharp latest

Pane.waitFor

Namespace L.FSharp LibTmux.FSharp

Waits as the request describes: patterns, stop patterns, or any output.

View as Markdown

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 waitFor: cancellationToken: CancellationToken -> request: PaneWaitRequest -> pane: LibTmux.Pane -> Task<PaneWaitResult>

function [source] ¶

Description#

Running out of time returns the outcome <c>TimedOut</c>; only <c>Mirror.waitUntil</c> raises instead.

Parameters

cancellationToken ( CancellationToken )
request ( PaneWaitRequest )
pane ( LibTmux.Pane )

Raises

LibTmux.TmuxPaneException – The pane's program had already exited.
LibTmux.TmuxObjectNotFoundException – tmux no longer has the pane.

Discussed in Getting started , Quick start