Variable breakPaneConst

Type Declaration

• • (
        options?:
            | {
                after?: boolean;
                before?: false;
                detached?: boolean;
                dstWindow?: string;
                format?: string;
                print?: boolean;
                srcPane?: string;
                windowName?: string;
            }
            | {
                after?: false;
                before?: boolean;
                detached?: boolean;
                dstWindow?: string;
                format?: string;
                print?: boolean;
                srcPane?: string;
                windowName?: string;
            },
    ): Effect<
        string,
        TmuxCommandOptionsError
        | TmuxProcessRunError,
        TmuxProcess,
    >

  • Parameters

    • Optionaloptions:
          | {
              after?: boolean;
              before?: false;
              detached?: boolean;
              dstWindow?: string;
              format?: string;
              print?: boolean;
              srcPane?: string;
              windowName?: string;
          }
          | {
              after?: false;
              before?: boolean;
              detached?: boolean;
              dstWindow?: string;
              format?: string;
              print?: boolean;
              srcPane?: string;
              windowName?: string;
          }
      • {
            after?: boolean;
            before?: false;
            detached?: boolean;
            dstWindow?: string;
            format?: string;
            print?: boolean;
            srcPane?: string;
            windowName?: string;
        }

        • Optional Readonlyafter?: boolean

          Move the new window to the index after dstWindow (-a).

        • Optional Readonlybefore?: false

        • Optional Readonlydetached?: boolean

          Do not make the new window the current window (-d).

        • Optional ReadonlydstWindow?: string

          Destination window location (-t).

        • Optional Readonlyformat?: string

          Format for -P output; default #{session_name}:#{window_index}.#{pane_index} (-F).

        • Optional Readonlyprint?: boolean

          Print information about the new window (-P).

        • Optional ReadonlysrcPane?: string

          Source pane to break off (-s).

        • Optional ReadonlywindowName?: string

          Name for the new window (-n).

      • {
            after?: false;
            before?: boolean;
            detached?: boolean;
            dstWindow?: string;
            format?: string;
            print?: boolean;
            srcPane?: string;
            windowName?: string;
        }

        • Optional Readonlyafter?: false

        • Optional Readonlybefore?: boolean

          Move the new window to the index before dstWindow (-b).

        • Optional Readonlydetached?: boolean

          Do not make the new window the current window (-d).

        • Optional ReadonlydstWindow?: string

          Destination window location (-t).

        • Optional Readonlyformat?: string

          Format for -P output; default #{session_name}:#{window_index}.#{pane_index} (-F).

        • Optional Readonlyprint?: boolean

          Print information about the new window (-P).

        • Optional ReadonlysrcPane?: string

          Source pane to break off (-s).

        • Optional ReadonlywindowName?: string

          Name for the new window (-n).

    Returns Effect<string, TmuxCommandOptionsError | TmuxProcessRunError, TmuxProcess>

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