Workspace ManagerAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

LibTmux.Workspace.WorkspacePlanOptions

API reference · Markdown

class LibTmux.Workspace.WorkspacePlanOptions
class [source]

Provides explicit policies copied into a workspace plan.

Discussed in C# workspace builder behavior , C# workspace builder API

Members

WorkspacePlanOptions

WorkspacePlanOptions ( )
method [source]

Initializes the default fail-on-conflict, immediate-input policy.

ExistingSession

ExistingSession : WorkspaceExistingSession
property [source]

Gets the policy for an existing session.

ServerStartup

ServerStartup : WorkspaceServerStartup
property [source]

Gets whether an initially absent endpoint may start or join a daemon.

Description#

CreateOrJoin does not claim exclusive startup or ownership of the daemon.

Readiness

Readiness : WorkspaceReadiness
property [source]

Gets the pane startup contract.

ReadinessTimeout

ReadinessTimeout : TimeSpan
property [source]

Gets the positive time allowed for each cooperative signal.

CompensateOnFailure

CompensateOnFailure : bool
property [source]

Gets whether failure removes journal-proven created resources.

Description#

Shell commands, host effects and global option changes are never reversed.

AllowHostScripts

AllowHostScripts : bool
property [source]

Gets whether a declared before_script may run on the host.

HostScriptTimeout

HostScriptTimeout : TimeSpan
property [source]

Gets the maximum duration of each host script, including output collection.

MaxHostOutputBytes

MaxHostOutputBytes : int
property [source]

Gets the combined stdout and stderr capture limit in UTF-8 bytes.

CleanupTimeout

CleanupTimeout : TimeSpan
property [source]

Gets the total budget for cleanup after application fails.

Esc

Type to search.