Type Alias TmuxClientConfig

TmuxClientConfig: Union<
    readonly [
        Struct<
            {
                configFile: optional<NonEmptyString>;
                executable: optional<NonEmptyString>;
                socketName: optional<NonEmptyString>;
                socketPath: optional<Never>;
            },
        >,
        Struct<
            {
                configFile: optional<NonEmptyString>;
                executable: optional<NonEmptyString>;
                socketName: optional<Never>;
                socketPath: optional<NonEmptyString>;
            },
        >,
    ],
>

Connection options shared by both the Promise client (new TmuxClient(config)) and the Effect layer (TmuxClient.layer(config)). All fields are optional; {} targets the default tmux server via the tmux binary on PATH.

socketName and socketPath are mutually exclusive — passing both is a type error, and also rejected at decode with TmuxClientConfigError. Each union member forbids the other socket field via optional(Never); both members still permit neither, so {} stays valid.

Type Alias TmuxClientConfig

Settings