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

    Variable selectPaneConst

    selectPane: (
        options?: {
            clearMarked?: boolean;
            disableInput?: boolean;
            down?: boolean;
            enableInput?: boolean;
            keepZoomed?: boolean;
            last?: boolean;
            left?: boolean;
            mark?: boolean;
            right?: boolean;
            targetPane?: string;
            title?: string;
            up?: boolean;
        },
    ) => Effect<
        string,
        TmuxCommandOptionsError
        | TmuxProcessRunError,
        TmuxProcess,
    > = ...

    Select a pane, or change pane state (tmux select-pane).

    Type Declaration

      • (
            options?: {
                clearMarked?: boolean;
                disableInput?: boolean;
                down?: boolean;
                enableInput?: boolean;
                keepZoomed?: boolean;
                last?: boolean;
                left?: boolean;
                mark?: boolean;
                right?: boolean;
                targetPane?: string;
                title?: string;
                up?: boolean;
            },
        ): Effect<
            string,
            TmuxCommandOptionsError
            | TmuxProcessRunError,
            TmuxProcess,
        >
      • Parameters

        • Optionaloptions: {
              clearMarked?: boolean;
              disableInput?: boolean;
              down?: boolean;
              enableInput?: boolean;
              keepZoomed?: boolean;
              last?: boolean;
              left?: boolean;
              mark?: boolean;
              right?: boolean;
              targetPane?: string;
              title?: string;
              up?: boolean;
          }
          • Optional ReadonlyclearMarked?: boolean

            Clear the marked pane (-M).

          • Optional ReadonlydisableInput?: boolean

            Disable input to the pane (-d).

          • Optional Readonlydown?: boolean

            Select the pane below the target pane (-D).

          • Optional ReadonlyenableInput?: boolean

            Enable input to the pane (-e).

          • Optional ReadonlykeepZoomed?: boolean

            Keep the window zoomed if it was zoomed (-Z).

          • Optional Readonlylast?: boolean

            Select the last (previously active) pane (-l).

          • Optional Readonlyleft?: boolean

            Select the pane to the left of the target pane (-L).

          • Optional Readonlymark?: boolean

            Mark the target pane (-m).

          • Optional Readonlyright?: boolean

            Select the pane to the right of the target pane (-R).

          • Optional ReadonlytargetPane?: string

            Target pane to make active (-t).

          • Optional Readonlytitle?: string

            Set the pane title (-T).

          • Optional Readonlyup?: boolean

            Select the pane above the target pane (-U).

        Returns Effect<string, TmuxCommandOptionsError | TmuxProcessRunError, TmuxProcess>

        An empty string on success.

    await tmux.selectPane({ targetPane: "work:1.0" });

    await tmux.selectPane({ down: true, keepZoomed: true });