Variable listPanes`Const`

listPanes: FormattedFn<
    {
        all?: boolean;
        filter?: string;
        session?: boolean;
        targetWindow?: string;
    },
    [],

        | "pane_index"
        | "pane_width"
        | "pane_height"
        | "history_size"
        | "history_limit"
        | "history_bytes"
        | "pane_id"
        | "pane_active"
        | "pane_dead",
    TmuxParseError
    | TmuxCommandOptionsError
    | TmuxProcessRunError,
> = ...

List tmux panes (tmux list-panes).

Returns

One record per pane.

Example

const panes = await tmux.listPanes({ targetWindow: "work:1" });
const allPanes = await tmux.listPanes({ all: true, includeVariables: ["session_name", "window_name"] });

Variable listPanesConst

Returns

Example

Settings

Variable listPanes`Const`