Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

planning.WorkspacePlan

TypeScript
  • Python Unavailable
  • Ruby Unavailable
  • Lua Unavailable
  • TypeScript
  • Rust Unavailable
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift Unavailable

API reference · Markdown

interface planning.WorkspacePlan
interface [source]
interface [source]
interface planning.WorkspacePlan

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

Discussed in TypeScript workspace builder API

Members

createsWindows

createsWindows : : readonly WorkspaceWindowCreation[]
propertyreadonly [source]
propertyreadonly [source]
createsWindows

Windows the apply would create, by the position they would take.

createsSession

createsSession : : boolean
propertyreadonly [source]
propertyreadonly [source]
createsSession

Whether the session itself would be created.

createsPanes

createsPanes : : readonly WorkspacePaneCreation[]
propertyreadonly [source]
propertyreadonly [source]
createsPanes

Panes the apply would create, grouped by desired window position.

removesPanes

removesPanes : : readonly WorkspacePaneRemoval[]
propertyreadonly [source]
propertyreadonly [source]
removesPanes

Panes the apply would destroy, with their containing placement.

removesWindows

removesWindows : : readonly WorkspaceWindowRemoval[]
propertyreadonly [source]
propertyreadonly [source]
removesWindows

Window placements the apply would kill or unlink.

owned

owned : : boolean
propertyreadonly [source]
propertyreadonly [source]
owned

Whether this workspace created the session it found.

renamesWindows

renamesWindows : : readonly WorkspaceWindowRename[]
propertyreadonly [source]
propertyreadonly [source]
renamesWindows

Existing windows the apply would rename.

retains

propertyreadonly [source]
propertyreadonly [source]
retains

Surplus this apply will leave alone, and why.

Empty when nothing is surplus or the policy removes it. A non-empty list on a session the workspace did not create is the case prune: "owned" exists for: the file and the server disagree, and the file does not get to win by default.

Esc

Type to search.