# types.FormatSubscription

- **Module:** types
- **Package:** libtmux
- **Language:** TypeScript
- **Kind:** interface
- **Source:** https://github.com/libtmux/libtmux-ts/blob/46cccfef2a546de55ce8b308249b8c76339089a0/packages/libtmux/src/types.ts#L688
- **Page:** https://libtmux.org/en/ts/latest/reference/types-formatsubscription/

A format tmux expands and reports whenever its value changes.

Reports arrive as [`TmuxSubscriptionEvent`](/en/ts/latest/reference/types-tmuxsubscriptionevent/). tmux evaluates every
subscription at most once per second, so this reports a change rather than
every intermediate value.

## Examples

```ts
{ format: "#{pane_current_command}", name: "cmd", scope: "all-panes" }
```

## Members

### Other members

- [`format`](/en/ts/latest/reference/types-formatsubscription-format/) (property): A tmux format string. See `FORMATS` in the tmux manual.
- [`name`](/en/ts/latest/reference/types-formatsubscription-name/) (property): The caller's label, echoed back on every report.
- [`scope`](/en/ts/latest/reference/types-formatsubscription-scope/) (property): What the format is expanded against. Omitted expands once per session.