Skip to content

wezterm.emit(event_name, args...)

Since: Version 20201031-154415-9614e117

The functionality described in this section requires version 20201031-154415-9614e117 of wezterm, or a more recent version.

wezterm.emit resolves the registered callback(s) for the specified event name and calls each of them in turn, passing the additional arguments through to the callback.

If a callback returns false then it prevents later callbacks from being called for this particular call to wezterm.emit, and wezterm.emit will return false to indicate that no additional/default processing should take place.

If none of the callbacks returned false then wezterm.emit will itself return true to indicate that default processing should take place.

This function has no special knowledge of which events are defined by wezterm, or what their required arguments might be.

See wezterm.on for more information about event handling.