Skip to main content

EVENT_RETURN (json)

Laurence MorganLess 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

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.yamlopen in new window.

Last update:
Contributors: Laurence Morgan