types.TmuxSubscriptionEvent

interface types.TmuxSubscriptionEvent

interface [source] ¶

interface [source] ¶

interface types.TmuxSubscriptionEvent

A subscribed format expanded to a new value.

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 , windowIndex and paneId are 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.

Members

• kind property
• name property The name given when subscribing.
• paneId property
• sessionId property
• value property The expanded format. Empty when the format expanded to nothing.
• windowId property
• windowIndex property The window's index within the session.