TypeScript API

window.Window.showOptions

TypeScript

Module: window
Declared in: Window
Package: libtmux
Source: packages/libtmux/src/window.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 window itself, not the ones it inherits.

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

In other ports Read the options set on a window

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

Examples

TypeScript Python Rust

const options = await window.showOptions();
options.get("automatic-rename");

>>> 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.new_window("w").await?;

window.set_option("main-pane-width", "99").await?;
let options = window.options().await?;
assert!(options.contains_key("main-pane-width"));

guard.shutdown().await?;

0 declared, 0 inherited