Variable rotateWindowConst

Type Declaration

• • (
        options?:
            | {
                down?: boolean;
                keepZoomed?: boolean;
                targetWindow?: string;
                up?: false;
            }
            | {
                down?: false;
                keepZoomed?: boolean;
                targetWindow?: string;
                up?: boolean;
            },
    ): Effect<
        string,
        TmuxCommandOptionsError
        | TmuxProcessRunError,
        TmuxProcess,
    >

  • Parameters

    • Optionaloptions:
          | {
              down?: boolean;
              keepZoomed?: boolean;
              targetWindow?: string;
              up?: false;
          }
          | {
              down?: false;
              keepZoomed?: boolean;
              targetWindow?: string;
              up?: boolean;
          }
      • { down?: boolean; keepZoomed?: boolean; targetWindow?: string; up?: false }

        • Optional Readonlydown?: boolean

          Rotate panes downward, to numerically higher positions (-D).

        • Optional ReadonlykeepZoomed?: boolean

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

        • Optional ReadonlytargetWindow?: string

          Target window whose panes are rotated (-t).

        • Optional Readonlyup?: false

      • { down?: false; keepZoomed?: boolean; targetWindow?: string; up?: boolean }

        • Optional Readonlydown?: false

        • Optional ReadonlykeepZoomed?: boolean

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

        • Optional ReadonlytargetWindow?: string

          Target window whose panes are rotated (-t).

        • Optional Readonlyup?: boolean

          Rotate panes upward, to numerically lower positions (-U).

    Returns Effect<string, TmuxCommandOptionsError | TmuxProcessRunError, TmuxProcess>

    An empty string on success.