builder.planWorkspace
- async function planWorkspace( server: Server, workspace
Input : WorkspaceInput , options: PlanWorkspace = {}, ): Promise<WorkspaceOptions Plan > -
Plan session, window, and pane membership without changing tmux.
Description#
Reads the server once and answers from that capture, so it costs one snapshot and changes nothing. It reports structural creation, removal, retention, and window renames. It does not predict options, layouts, focus, or pane command effects.
Examples#
const plan = await planWorkspace(server, workspace);if (plan.removesWindows.length > 0) console.log("would remove", plan.removesWindows);- Parameters
-
-
options={}(PlanWorkspace ) #Options
- Raises
-
-
ZodError – when the workspace does not satisfy the strict config schema.
-
Type
Error – when planning options are invalid.
-
Guides#
Pages that discuss planWorkspace.