# server.ServerOptions

- **Module:** server
- **Package:** libtmux
- **Language:** TypeScript
- **Kind:** interface
- **Source:** https://github.com/libtmux/libtmux-ts/blob/46cccfef2a546de55ce8b308249b8c76339089a0/packages/libtmux/src/server.ts#L109
- **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
[`ServerOptions.environment`](/en/ts/latest/reference/server-serveroptions-environment/), which replaces the process environment
rather than extending it. [`socketName`](/en/ts/latest/reference/server-serveroptions-socketname/) and [`socketPath`](/en/ts/latest/reference/server-serveroptions-socketpath/) name the same thing
two ways and are mutually exclusive.

## Members

### Common operations

- [`onInvocation`](/en/ts/latest/reference/server-serveroptions-oninvocation/) (property): Called once per tmux invocation, after it answers or fails.

### Other members

- [`colors`](/en/ts/latest/reference/server-serveroptions-colors/) (property)
- [`configFile`](/en/ts/latest/reference/server-serveroptions-configfile/) (property)
- [`engine`](/en/ts/latest/reference/server-serveroptions-engine/) (property): Run this server's commands somewhere other than a local `tmux`.
- [`environment`](/en/ts/latest/reference/server-serveroptions-environment/) (property): The complete environment passed to every spawned `tmux` process.
- [`maxInFlight`](/en/ts/latest/reference/server-serveroptions-maxinflight/) (property): How many tmux invocations this server runs at once. Defaults to 16.
- [`socketName`](/en/ts/latest/reference/server-serveroptions-socketname/) (property)
- [`socketPath`](/en/ts/latest/reference/server-serveroptions-socketpath/) (property)
- [`timeoutMs`](/en/ts/latest/reference/server-serveroptions-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`](/en/ts/latest/reference/server-serveroptions-tmuxbin/) (property)