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

TypeScript API

pane.Pane.capture

TypeScript

View as Markdown

Module: pane
Declared in: Pane
Package: libtmux
Source: packages/libtmux/src/pane.ts
Other languages: Python Ruby Lua Rust Go Java .NET C++Swift

capture ( options : : CaptureOptions ) → Promise<readonly string[]> method [source] ¶ method [source] ¶ capture

Capture this pane's contents as lines.

In other ports Read a pane’s visible contents

Python libtmux.Pane.capture_pane
Ruby LibTmux::Pane#capture
Lua libtmux.Pane:capture
Rust pane.Pane.capture
Go tmux.Pane.Capture
Java io.github.libtmux.Pane.Pane.capture
.NET LibTmux.Pane.CaptureAsync
C++ libtmux::Pane::capture
Swift Server.capture(_:includingHistory:)

Examples

TypeScript Python

const lines = await pane.capture();
lines.at(-1);

>>> pane = window.split(shell='sh')
>>> pane.capture_pane()
['$']

>>> pane.send_keys('echo "Hello world"', enter=True)

>>> pane.capture_pane()
['$ echo "Hello world"', 'Hello world', '$']

>>> print(chr(10).join(pane.capture_pane()))
$ echo "Hello world"
Hello world
$

0 declared, 0 inherited