TypeScript API

session.Session.setOption

TypeScript

Python
Ruby Unavailable
Lua
TypeScript
Rust
Go
Java Unavailable
.NET Unavailable
C++
Swift

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

setOption ( name : : string , value : : string , options : : SetOptionOptions ) → Promise<void> method [source] ¶ method [source] ¶ setOption

Set an option on this session.

In other ports Set a session option

Python libtmux.Session.set_option
Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua libtmux.Session:set_option
Rust session.Session.set_option
Go tmux.Session.SetOption
Java reached through Session.options, whose Options carries the write
.NET reached through Session.Options, whose TmuxOptions carries the write
C++ libtmux::Session::set_option
Swift Server.setOption(_:to:scope:)

Examples

TypeScript Python

await session.setOption("status", "off");

>>> import typing as t
>>> from libtmux.common import tmux_cmd
>>> from libtmux.constants import OptionScope
>>> from libtmux._internal.sparse_array import SparseArray

>>> class MyServer(OptionsMixin):
...     socket_name = server.socket_name
...     def cmd(self, cmd: str, *args: object):
...         cmd_args: t.List[t.Union[str, int]] = [cmd]
...         if self.socket_name:
...             cmd_args.insert(0, f"-L{self.socket_name}")
...         cmd_args.insert(0, "-f/dev/null")
...         return tmux_cmd(*cmd_args, *args)
...
...     default_option_scope = OptionScope.Server

>>> MyServer().set_option('escape-time', 1250)
<libtmux.options.MyServer object at ...>

>>> MyServer()._show_option('escape-time')
1250

>>> MyServer().set_option('escape-time', 495)
<libtmux.options.MyServer object at ...>

>>> MyServer()._show_option('escape-time')
495

0 declared, 0 inherited