client.Client

class client.Client

classoverload [source] ¶

classoverload [source] ¶

class client.Client

One client attached to a tmux server, as a handle rather than a copy of it.

Reached from Server.clients ; the constructor throws. A client is the shortest-lived thing here — it goes away when its terminal does — so Client.session reports undefined once it has detached, and every other read reflects the moment the handle was made.

Members

• detach method Detach this client from its server.
• pane method The pane this client currently has active.
• refreshed method This client, read again at a new instant.
• server attribute The server this handle addresses.
• session method The session this client is attached to, if it is still attached.
• switchTo method Point this client at a different session.
• window method The window placement this client currently shows.
• clientBrand attribute
• constructor method
• equals method
• format property The raw tmux format row, addressed by tmux's own token names.
• toString method How this handle renders in a log line, a template literal, or an error.