TmuxSubscriptionEvent
A subscribed format expanded to a new value.
Source and package
- Qualified name
-
TmuxSubscription Event - Module
- types
- Package
- libtmux
- Source
- packages/libtmux/src/types.ts
-
Description#
tmux evaluates a subscription at most once per second and reports only when the value differs from the last report for that object; the first evaluation always reports.
windowId,windowIndexandpaneIdare the object the value was expanded against, and are absent for a session-scope subscription.The value is written raw, so a format expanding to a newline arrives as further lines this parser cannot attribute. Keep a subscribed format on one line.
Members7#
- kind: "subscription-changed" property
- name: string property The name given when subscribing.
- paneId: Pane
Id property - sessionId: Session
Id property - value: string property The expanded format. Empty when the format expanded to nothing.
- windowId: Window
Id property - windowIndex: number property The window's index within the session.