ServerOptions
How to reach a tmux server, and what to assume when it is quiet.
Source and package
- Qualified name
-
ServerOptions - Module
- server
- Package
- libtmux
- Source
- packages/libtmux/src/server.ts
-
Description#
Every field is optional and every default is tmux's own, except
ServerOptions.environment, which replaces the process environment rather than extending it, and the socket, whichLIBTMUX_SOCKET_PATHorLIBTMUX_SOCKETchoose when neithersocketNamenorsocketPathis given. Those two name the same thing two ways and are mutually exclusive.
Members10#
Common operations1#
- onInvocation: Tmux
Invocation property Called once per tmux invocation, after it answers or fails.Observer
Other members9#
- colors: 256 property
- configFile: string property
- engine: Tmux
Engine property Run this server's commands somewhere other than a localtmux. - environment: Readonly<Record<string, string | undefined>> property The complete environment passed to every spawned
tmuxprocess. - maxInFlight: number property How many tmux invocations this server runs at once. Defaults to 16.
- socketName: string property The socket name, passed to tmux as
-L. - socketPath: string property The socket path, passed to tmux as
-S. - timeoutMs: number | null property Default deadline, in milliseconds, for every command this server runs: 30 seconds unless set.
nullremoves it, so commands wait as long as tmux takes. - tmuxBin: string property