# types.TmuxSubscriptionEvent

- **Module:** types
- **Package:** libtmux
- **Language:** TypeScript
- **Kind:** interface
- **Source:** https://github.com/libtmux/libtmux-ts/blob/46cccfef2a546de55ce8b308249b8c76339089a0/packages/libtmux/src/types.ts#L721
- **Page:** https://libtmux.org/en/ts/latest/reference/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`](/en/ts/latest/reference/types-tmuxsubscriptionevent-windowid/), [`windowIndex`](/en/ts/latest/reference/types-tmuxsubscriptionevent-windowindex/) and [`paneId`](/en/ts/latest/reference/types-tmuxsubscriptionevent-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

### Other members

- [`kind`](/en/ts/latest/reference/types-tmuxsubscriptionevent-kind/) (property)
- [`name`](/en/ts/latest/reference/types-tmuxsubscriptionevent-name/) (property): The name given when subscribing.
- [`paneId`](/en/ts/latest/reference/types-tmuxsubscriptionevent-paneid/) (property)
- [`sessionId`](/en/ts/latest/reference/types-tmuxsubscriptionevent-sessionid/) (property)
- [`value`](/en/ts/latest/reference/types-tmuxsubscriptionevent-value/) (property): The expanded format. Empty when the format expanded to nothing.
- [`windowId`](/en/ts/latest/reference/types-tmuxsubscriptionevent-windowid/) (property)
- [`windowIndex`](/en/ts/latest/reference/types-tmuxsubscriptionevent-windowindex/) (property): The window's index within the session.
