Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-ts latest

Session.getEnvironment

One variable from this session's environment, or undefined when tmux carries no entry.

Source and package
Qualified name
Session.getEnvironment
Module
session
Declared in
Session
Package
libtmux
Source
packages/libtmux/src/session.ts
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua RustGo Java C# C++ Swift Kotlin Scala OCaml F# Clojure

Examples#

await session.getEnvironment("EDITOR"); // "vim", null, or undefined
Parameters

tmux command#

The tmux commands behind getEnvironment.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Read one variable from a session's environment

Equivalents of Read one variable from a session's environment in other languages
Language Equivalent
Python no single-variable read; the whole table is returned
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Rust session.Session.environment
Go tmux.Session.GetEnvironment
Java no single-variable read; the whole table is returned
C# no single-variable read; the whole table is returned
C++ no single-variable read; the whole table is returned
Swift no single-variable read; the whole table is returned
OCaml No direct public OCaml equivalent is recorded for this operation.
Perl LibTmux::Server::get_environment Pass an explicit session ID. Empty text and zero-like text remain values.

No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference