EVENT_RETURN (json)

Return values for events

Description

Some events support return parameters outside of your typical stdout and stderr streams. $EVENT_RETURN allows you to modify those parameters.

Examples

event onPreview example=exec {
    -> set event
    out "Preview event for $(event.Interrupt.PreviewItem)"
    
    $EVENT_RETURN.CacheTTL = 0 # don't cache this response.
}

Detail

$EVENT_RETURN will support different values for different events. Please read the respective event document for details on using this variable.

Other Reserved Variables

• Numeric (str): Variables who's name is a positive integer, eg 0, 1, 2, 3 and above
• $., Meta Values (json): State information for iteration blocks
• ARGV (json): Array of the command name and parameters within a given scope
• COLUMNS (int): Character width of terminal
• EVENT_RETURN (json): Return values for events
• HOSTNAME (str): Hostname of the current machine
• MUREX_ARGV (json): Array of the command name and parameters passed to the current shell
• MUREX_EXE (path): Absolute path to running shell
• PARAMS (json): Array of the parameters within a given scope
• PWDHIST (json): History of each change to the sessions working directory
• PWD (path): Current working directory
• SELF (json): Meta information about the running scope.
• SHELL (str): Path of current shell

See Also

• event: Event driven programming for shell scripts
• json: JavaScript Object Notation (JSON)
• onKeyPress: Custom definable key bindings and macros
• onPreview: Full screen previews for files and command documentation

---

This document was generated from gen/variables/EVENT_RETURN_doc.yaml.