session.Session

class session.Session

classoverload [source] ¶

classoverload [source] ¶

class session.Session

Discussed in Architecture

Members

• server attribute The server this handle addresses.
• sessionBrand attribute
• activePane method The pane tmux marks active in this session's active window.
• activeWindow method The window tmux marks active in this session.
• cmd method Run a tmux command this package does not model, addressed at this session.
• constructor method
• detach method Detach every client attached to this session.
• equals method Whether other is this same session on this same server.
• fromEnv method Resolve the session this process is running inside.
• getEnvironment method One variable from this session's environment, or undefined when tmux carries no entry.
• kill method Destroy this session.
• newWindow method Create a window in this session and resolve it as a handle.
• panes method Panes contained by this session's windows.
• plan method The same mutations, described instead of run.
• refreshed method This session, read again at a new instant.
• removeEnvironment method Mark a variable in this session's environment for removal from the environment of processes tmux starts, leaving the entry in place.
• rename method Rename this session.
• sameTmuxIdAs method Whether other carries the same $n, wherever it came from.
• selectWindow method Select the last, next, or previous window, or one named by target.
• setEnvironment method Set a variable in this session's environment.
• setHook method Bind a tmux command to a hook on this session.
• setOption method Set an option on this session.
• showEnvironment method Every variable in this session's environment.
• showHooks method Every hook this session reports.
• showOptions method Every option set on this session itself, not the ones it inherits.
• showResolvedOptions method The option values that govern this session, own and inherited together.
• toString method How this handle renders in a log line, a template literal, or an error.
• unsetEnvironment method Drop a variable from this session's environment entirely.
• unsetHook method Remove a hook from this session.
• unsetOption method Remove an option from this session.
• windows method Windows placed in this session, in listing order.
• format property The raw tmux format row, addressed by tmux's own token names.