@totallyinformation/node-red-contrib-events/src/editor/event-out/help.html

Event broadcast and receive nodes for Node-RED.

<p>
    Event-driven notifications. Create an event from an input msg.topic.
    Any <code>event-in</code> node with a matching topic specified will receive the input msg.
</p>

<h3>Inputs</h3>
<dl class="message-properties">
    <dt class="optional">payload <span class="property-type">string | buffer</span></dt>
    <dd> Optionally, the payload of the message to send to all connected client browser tabs. </dd>

    <dt class="optional">topic <span class="property-type">string</span></dt>
    <dd> Optionally, the MQTT topic to use. Takes preference over the topic defined in settings.</dd>
</dl>

<h3>Outputs</h3>
<p>
    If <code>passthrough</code> is set, the input message is sent to the output.
</p>

<h3>Node Settings</h3>
<dl class="message-properties">
    <dt>Name <span class="property-type">string</span></dt>
    <dd>A short description shown in the admin interface</dd>

    <dt>Topic <span class="property-type">string</span></dt>
    <dd>A topic name to use if the incoming msg does not contain one.</dd>

    <dt>passthrough <span class="property-type">string, hidden</span></dt>
    <dd>
        Set by the 3 radio buttons to one of 'none', 'input', or 'return'.
        <ul>
            <li>
                <b>None</b>: No output port.
            </li>
            <li>
                <b>Input</b>: A copy of the input msg is sent to the output.
            </li>
            <li>
                <b>Return</b>: The node listens for output from an <code>event-return</code> node receiving a <code>msg._eventOriginator</code> property having the same ID as this node.
                This allows for sub-flows and loops to be created.
            </li>
        </ul>
    </dd>
</dl>