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.

class libtmux-ts latest

Client

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

Source and package
Qualified name
Client
Module
client
Package
libtmux
Source
packages/libtmux/src/client.ts
class client.Client

Description#

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.

Members12#

Parent objects2#

  • session method The session this client is attached to, if it is still attached.
  • server: Server attribute The server this handle addresses.

Common operations5#

  • 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.
  • switchTo method Point this client at a different session.
  • window method The window placement this client currently shows.

Other members5#

Guides#

Pages that discuss Client.

Esc

Type to search.

Reference previewOpen reference