Renamed resetTimeout to restartTimeout

Updated documentation differently
This commit is contained in:
Magnus Månsson 2021-08-25 21:53:37 +02:00
parent cf2d5841f5
commit f20565fd16
2 changed files with 2 additions and 3 deletions

View File

@ -631,7 +631,7 @@ module.exports = function(RED) {
}
}
if (msg.hasOwnProperty("resetTimeout")) {
if (msg.hasOwnProperty("restartTimeout")) {
if (inflight[partId]) {
if (inflight[partId].timeout) {
clearTimeout(inflight[partId].timeout);

View File

@ -115,10 +115,9 @@
<p>A <i>count</i> can be set for how many messages should be received before generating the output message.
For object outputs, once this count has been reached, the node can be configured to send a message for each subsequent message
received.</p>
<p>A <i>timeout</i> can be set to trigger sending the new message using whatever has been received so far.</p>
<p>A <i>timeout</i> can be set to trigger sending the new message using whatever has been received so far. This timeout can be restarted and set to its initial value by sending a message with the <code>msg.restartTimeout</code> property set.</p>
<p>If a message is received with the <code>msg.complete</code> property set, the output message is finalised and sent.
This resets any part counts.</p>
<p>If a message is received with the <code>msg.resetTimeout</code> property set, the timer for the partly complete message is reset to the original time.
<p>If a message is received with the <code>msg.reset</code> property set, the partly complete message is deleted and not sent.
This resets any part counts.</p>