TypeScript API

pane.Pane.showOptions

TypeScript

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

showOptions ( ) → Promise<ReadonlyMap<string, string>> method [source] ¶ method [source] ¶ showOptions

Every option set on this pane itself, not the ones it inherits.

A fresh pane usually has none, so an empty map here means nothing was set on this pane — not that the option has no value. showResolvedOptions answers what actually governs it.

Discussed in Options and hooks

In other ports Read the options set on a pane

Python libtmux.Pane.show_options
Ruby LibTmux::Pane#options
Lua No source-verified Lua equivalent is recorded for this operation.
Rust pane.Pane.options
Go tmux.Pane.Options
Java io.github.libtmux.Pane.Pane.options
.NET LibTmux.Pane.Options
C++ libtmux::Pane::options
Swift Server.options(_:)

Examples

TypeScript Python Rust

const options = await pane.showOptions();
options.get("remain-on-exit");

>>> options = server.show_options()
>>> isinstance(options, dict)
True

>>> 'buffer-limit' in options
True

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("opts").await?;
let window = session.active_window().await?.expect("a session has a window");
let pane = window.active_pane().await?.expect("a window has a pane");

pane.set_option("@marker", "set").await?;
assert!(pane.options().await?.contains_key("@marker"));

guard.shutdown().await?;

0 declared, 0 inherited