tmux.ts - v0.1.3
    Preparing search index...

    Variable splitWindowConst

    splitWindow: (
        ...args: [
            shellCommand: string,
            options?: {
                before?: boolean;
                detached?: boolean;
                environment?: string;
                format?: string;
                full?: boolean;
                horizontal?: boolean;
                print?: boolean;
                size?: string
                | number;
                startDirectory?: string;
                targetPane?: string;
                vertical?: boolean;
                zoom?: boolean;
            },
        ],
    ) => Effect<
        string,
        TmuxCommandOptionsError
        | TmuxProcessRunError,
        TmuxProcess,
    > = ...

    Split a tmux pane into a new pane (tmux split-window).

    Type Declaration

      • (
            ...args: [
                shellCommand: string,
                options?: {
                    before?: boolean;
                    detached?: boolean;
                    environment?: string;
                    format?: string;
                    full?: boolean;
                    horizontal?: boolean;
                    print?: boolean;
                    size?: string
                    | number;
                    startDirectory?: string;
                    targetPane?: string;
                    vertical?: boolean;
                    zoom?: boolean;
                },
            ],
        ): Effect<
            string,
            TmuxCommandOptionsError
            | TmuxProcessRunError,
            TmuxProcess,
        >
      • Parameters

        • ...args: [
              shellCommand: string,
              options?: {
                  before?: boolean;
                  detached?: boolean;
                  environment?: string;
                  format?: string;
                  full?: boolean;
                  horizontal?: boolean;
                  print?: boolean;
                  size?: string
                  | number;
                  startDirectory?: string;
                  targetPane?: string;
                  vertical?: boolean;
                  zoom?: boolean;
              },
          ]

        Returns Effect<string, TmuxCommandOptionsError | TmuxProcessRunError, TmuxProcess>

        The -P formatted line when { print: true }, otherwise an empty string.

    await tmux.splitWindow(undefined, { horizontal: true, detached: true });

    const line = await tmux.splitWindow("htop", { print: true, size: "30%" });