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.

interface libtmux-ts latest

FormatSubscription

A format tmux expands and reports whenever its value changes.

Source and package
Qualified name
FormatSubscription
Module
types
Package
libtmux
Source
packages/libtmux/src/types.ts
interface types.FormatSubscription

Description#

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" }

Members3#

  • format: string property A tmux format string. See FORMATS in the tmux manual.
  • name: string property The caller's label, echoed back on every report.
  • scope: PaneId | WindowId | "all-panes" | "all-windows" property What the format is expanded against. Omitted expands once per session.
Esc

Type to search.

Reference previewOpen reference