# planning.WorkspacePlan

**Workspace Manager concept example** A working example of the core library. It can change without notice.

- **Module:** planning
- **Package:** @libtmux/workspace
- **Language:** TypeScript
- **Kind:** interface
- **Source:** https://github.com/libtmux/libtmux-ts/blob/46cccfef2a546de55ce8b308249b8c76339089a0/packages/workspace/src/planning.ts#L64
- **Page:** https://libtmux.org/en/ts/latest/workspace/reference/planning-workspaceplan/

Session, window, and pane membership changes an apply would make.

## Members

### Other members

- [`createsPanes`](/en/ts/latest/workspace/reference/planning-workspaceplan-createspanes/) (property): Panes the apply would create, grouped by desired window position.
- [`createsSession`](/en/ts/latest/workspace/reference/planning-workspaceplan-createssession/) (property): Whether the session itself would be created.
- [`createsWindows`](/en/ts/latest/workspace/reference/planning-workspaceplan-createswindows/) (property): Windows the apply would create, by the position they would take.
- [`owned`](/en/ts/latest/workspace/reference/planning-workspaceplan-owned/) (property): Whether this workspace created the session it found.
- [`removesPanes`](/en/ts/latest/workspace/reference/planning-workspaceplan-removespanes/) (property): Panes the apply would destroy, with their containing placement.
- [`removesWindows`](/en/ts/latest/workspace/reference/planning-workspaceplan-removeswindows/) (property): Window placements the apply would kill or unlink.
- [`renamesWindows`](/en/ts/latest/workspace/reference/planning-workspaceplan-renameswindows/) (property): Existing windows the apply would rename.
- [`retains`](/en/ts/latest/workspace/reference/planning-workspaceplan-retains/) (property): Surplus this apply will leave alone, and why.

## Guides

Pages that discuss `WorkspacePlan`.

- [TypeScript workspace builder API](/en/ts/latest/workspace/reference/)