TypeScript API

pane.Pane.breakOut

TypeScript

Module: pane
Declared in: Pane
Package: libtmux
Source: packages/libtmux/src/pane.ts
Other languages: Python Ruby Lua Rust Go Java .NET C++Swift

breakOut ( windowName : : string ) → Promise<void> method [source] ¶ method [source] ¶ breakOut

Move this pane out into a window of its own, in the session it is in.

tmux places a break with no destination in whichever session is current, which is the attached one rather than this pane's.

In other ports Move a pane out into a window of its own

Python libtmux.Pane.break_pane
Ruby LibTmux::Pane#break_out
Lua libtmux.Pane:break_out
Rust pane.Pane.break_out
Go tmux.Pane.BreakPane
Java io.github.libtmux.Pane.Pane.breakOut
.NET LibTmux.Pane.BreakAsync
C++ libtmux::Pane::break_out
Swift Server.breakPane(_:from:named:)

Examples

TypeScript Python Rust

await pane.breakOut("extracted");

>>> pane_to_break = window.split(shell='sleep 1m')
>>> new_window = pane_to_break.break_pane(window_name='broken')
>>> new_window.window_name
'broken'

use libtmux::{SplitDirection, SplitOptions};

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("broken-out").await?;
let pane = session.panes().await?.remove(0);
let stays = pane.window_id().clone();

let moved = pane.split(SplitOptions::new(SplitDirection::Below)).await?;
let moved = moved.break_out().await?;

// The window it landed in, without listing the server to find it.
assert_ne!(moved.window_id(), &stays);

0 declared, 0 inherited