TypeScript API

server.Server.setEnvironment

TypeScript

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

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

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

Set a variable in the server's global environment.

Discussed in Environment

In other ports Set a variable in the server's environment

Python libtmux.Server.set_environment
Ruby LibTmux::Server#set_environment
Lua libtmux.Server:set_environment
Rust server.Server.set_environment
Go tmux.Server.SetEnvironment
Java no equivalent on Server
.NET no equivalent on Server
C++ no equivalent on Server
Swift Server.setEnvironment(_:to:in:)

Examples

TypeScript Rust

await server.setEnvironment("EDITOR", "vim");

use libtmux::EnvironmentEntry;

let guard = libtmux::test::TestServer::new().await?;
let server = guard.server();

server.set_environment("EDITOR", "hx").await?;
assert!(matches!(
    server.environment("EDITOR").await?,
    Some(EnvironmentEntry::Set(value)) if value.as_bytes() == b"hx",
));

// Separate stores: the session has no entry of its own, and reading it
// does not fall back to the server. The value still reaches a process
// the session starts.
let session = server.new_session("separate").await?;
assert_eq!(session.environment("EDITOR").await?, None);

guard.shutdown().await?;

0 declared, 0 inherited