TypeScript API

session.Session.showOptions

TypeScript

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

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

In other ports Read the options set on a session

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

Examples

TypeScript Python Rust

const options = await session.showOptions();
options.get("status");

>>> 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?;

session.set_option("status-left-length", "30").await?;
let options = session.options().await?;
assert!(options.contains_key("status-left-length"));

guard.shutdown().await?;

0 declared, 0 inherited