# server.ServerOptions

- **Module:** server
- **Package:** libtmux
- **Language:** TypeScript
- **Kind:** interface
- **Source:** https://github.com/libtmux/libtmux-ts/blob/3fe1ca654b81b8cbf4a13b777a001a3298c87a6f/packages/libtmux/src/server.ts#L100
- **Page:** https://libtmux.org/en/ts/latest/reference/server-serveroptions/

How to reach a tmux server, and what to assume when it is quiet.

Every field is optional and every default is tmux's own, except
{@link ServerOptions.environment}, which replaces the process environment
rather than extending it. `socketName` and `socketPath` name the same thing
two ways and are mutually exclusive.

## Members

- `colors` (property)
- `configFile` (property)
- `environment` (property): The complete environment passed to every spawned `tmux` process.
- `maxInFlight` (property): How many tmux invocations this server runs at once. Defaults to 16.
- `socketName` (property)
- `socketPath` (property)
- `timeoutMs` (property): Default deadline, in milliseconds, for every command this server runs: 30 seconds unless set. `null` removes it, so commands wait as long as tmux takes.
- `tmuxBin` (property)
- `onInvocation` (property): Called once per tmux invocation, after it answers or fails.
- `engine` (property): Run this server's commands somewhere other than a local `tmux`.