ConnectedServer.subscribeFormat
Report a format whenever tmux expands it to a new value.
Source and package
- Qualified name
-
ConnectedServer. subscribe Format - Module
- types
- Declared in
ConnectedServer- Package
- libtmux
- Source
- packages/libtmux/src/types.ts
- subscribeFormat( subscription: Format
Subscription , ): Promise<void> -
Description#
Reports arrive on
subscribe()asTmuxSubscriptionEvent. Re-using a name replaces that subscription. The connection re-issues its subscriptions after a reconnect, because they belong to the control client that went away.Examples#
await live.subscribeFormat({format: "#{pane_current_command}",name: "cmd",scope: "all-panes",});- Parameters
- Raises
-
-
Type
Error – when the name holds:, whitespace, or a control character, or the format holds a line break — each of which tmux would either misread or report unattributably.
-