Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-go latest

Plan.Preview

Preview renders every recorded operation's argument vector without running anything, for the tmux version given.

Source and package
Qualified name
tmux.Plan.Preview
Package
tmux
Declared in
Plan
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/plan.go
func (p *Plan) Preview(version Version) ([][]string, error)

Description#

An entry is nil when it references an object an earlier step has not created. Such an operation is still rendered against a placeholder target and checked, so a request tmux of that version would refuse, or an unsupported flag under the default fail policy, is an error here too; only its arguments are left out, because they depend on an ID that does not exist yet.

Render failures return the entries completed before the error. Preview catches them before a non-atomic run can partially mutate tmux.

Parameters
Esc

Type to search.

Reference previewOpen reference