update-right-status event is emitted periodically (based on the
interval specified by the status_update_interval
There is no defined return value for the event, but its purpose is to allow you the chance to carry out some activity and then ultimately call window:set_right_status.
The first event parameter is a
window object that
represents the gui window.
The second event parameter is a
pane object that
represents the active pane in that window.
wezterm will ensure that only a single instance of this event is outstanding;
if the hook takes longer than the
status_update_interval to complete,
wezterm won't schedule another call until
milliseconds have elapsed since the last call completed.
This event is considered to be deprecated and you should migrate to using update-status, which behaves the same way, but doesn't overly focus on the right status area.