On this page

types.FormatSubscription

Module: types
Package: @libtmux/libtmux
Source: packages/libtmux/src/types.ts

interface types.FormatSubscription interface [source] ¶ interface [source] ¶ interface types.FormatSubscription

A format tmux expands and reports whenever its value changes.

Reports arrive as TmuxSubscriptionEvent . tmux evaluates every subscription at most once per second, so this reports a change rather than every intermediate value.

Examples

{ format: "#{pane_current_command}", name: "cmd", scope: "all-panes" }

3 declared, 0 inherited

Members

format property A tmux format string. See FORMATS in the tmux manual.
name property The caller's label, echoed back on every report.
scope property What the format is expanded against. Omitted expands once per session.