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.

interface libtmux-ts latest

ConnectedServer

A server with a persistent observation connection and daemon-lifetime tracking.

Source and package
Qualified name
ConnectedServer
Module
types
Package
libtmux
Source
packages/libtmux/src/types.ts
interface types.ConnectedServer

Description#

Commands use the ordinary command engine. Disposing it closes the observation connection and leaves the tmux server and its resources running.

Members6#

Common operations2#

  • waitFor method Resolve once the server satisfies matches, or reject on timeout.
  • subscribeFormat method Report a format whenever tmux expands it to a new value.

Other members4#

  • [Symbol.asyncDispose] method
  • close method End the connection. Safe to call more than once.
  • subscribe method Open an independent view of the notifications arriving on this connection.
  • unsubscribeFormat method Stop reporting a subscription. Unknown names are accepted.
Esc

Type to search.

Reference previewOpen reference