Variable joinPaneConst

Type Declaration

• • (
        options?: {
            before?: boolean;
            detached?: boolean;
            full?: boolean;
            horizontal?: boolean;
            size?: string | number;
            sourcePane?: string;
            targetPane?: string;
            vertical?: boolean;
        },
    ): Effect<
        string,
        TmuxCommandOptionsError
        | TmuxProcessRunError,
        TmuxProcess,
    >

  • Parameters

    • Optionaloptions: {
          before?: boolean;
          detached?: boolean;
          full?: boolean;
          horizontal?: boolean;
          size?: string | number;
          sourcePane?: string;
          targetPane?: string;
          vertical?: boolean;
      }

      • Optional Readonlybefore?: boolean

        Join the source pane to the left of or above the target pane (-b).

      • Optional Readonlydetached?: boolean

        Do not make the joined pane the active pane (-d).

      • Optional Readonlyfull?: boolean

        Span the full window height or width instead of the target size (-f).

      • Optional Readonlyhorizontal?: boolean

        Split horizontally (left/right) instead of vertically (-h).

      • Optional Readonlysize?: string | number

        Size in lines/columns, or a percentage string ending in % (-l).

      • Optional ReadonlysourcePane?: string

        Source pane to move; defaults to the marked pane (-s).

      • Optional ReadonlytargetPane?: string

        Destination pane to join into (-t).

      • Optional Readonlyvertical?: boolean

        Split vertically (top/bottom); the default (-v).

    Returns Effect<string, TmuxCommandOptionsError | TmuxProcessRunError, TmuxProcess>

    An empty string on success.