builder.planWorkspace
TypeScript
- Python Unavailable
- Ruby Unavailable
- Lua Unavailable
- TypeScript
- Rust Unavailable
- Go Unavailable
- Java Unavailable
- .NET Unavailable
- C++ Unavailable
- Swift Unavailable
- builder.planWorkspace ( server : : Server , workspaceInput : : WorkspaceInput , options : : PlanWorkspaceOptions = {} ) Promise<WorkspacePlan>
-
Plan session, window, and pane membership without changing tmux.
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);- Raises
-
-
ZodError – when the workspace does not satisfy the strict config schema.
-
TypeError – when planning options are invalid.
-
Discussed in TypeScript workspace internals , Use the TypeScript workspace builder , TypeScript workspace builder behavior , TypeScript workspace builder API