EVENT_RETURN (json)
Less than 1 minute
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 blocksARGV
(json): Array of the command name and parameters within a given scopeCOLUMNS
(int): Character width of terminalEVENT_RETURN
(json): Return values for eventsHOSTNAME
(str): Hostname of the current machineMUREX_ARGV
(json): Array of the command name and parameters passed to the current shellMUREX_EXE
(path): Absolute path to running shellPARAMS
(json): Array of the parameters within a given scopePWDHIST
(json): History of each change to the sessions working directoryPWD
(path): Current working directorySELF
(json): Meta information about the running scope.SHELL
(str): Path of current shell
See Also
event
: Event driven programming for shell scriptsjson
: JavaScript Object Notation (JSON)onKeyPress
: Custom definable key bindings and macrosonPreview
: Full screen previews for files and command documentation
This document was generated from gen/variables/EVENT_RETURN_doc.yaml.