- Docs for various nodes updated (closes #9)

- Fixed some nodes not matching how their docs describe how they function (such as node configuration should always take precedence over inputs)
This commit is contained in:
2021-09-02 10:51:47 -06:00
parent b698389491
commit 4bd2dce434
24 changed files with 184 additions and 184 deletions
+7 -9
View File
@@ -31,9 +31,6 @@
<label for="node-input-roomId"><i class="fa fa-user"></i> Room ID</label>
<input type="text" id="node-input-roomId" placeholder="msg.topic">
</div>
<div class="form-tips">
Room ID must either be defined here or passed in via <code>msg.topic</code>. The config takes precedence over the input.
</div>
</script>
<script type="text/html" data-help-name="matrix-room-ban">
@@ -42,18 +39,18 @@
<h3>Inputs</h3>
<dl class="message-properties">
<dt class="optional">msg.userId
<span class="property-type">String</span>
<dt>msg.userId
<span class="property-type">string</span>
</dt>
<dd> The ID of the user to ban.</dd>
<dt class="optional">msg.topic
<span class="property-type">String | Null</span>
<span class="property-type">string | null</span>
</dt>
<dd> The room to ban the user from. Required if not defined on the config. Config takes precedence.</dd>
<dd> The room to ban the user from. Ignored if configured on the node, otherwise required.</dd>
<dt class="optional">msg.reason
<span class="property-type">String</span>
<span class="property-type">string</span>
</dt>
<dd> Reason for banning the user.</dd>
</dl>
@@ -62,7 +59,8 @@
<ol class="node-ports">
<li>Success
<dl class="message-properties">
<dd>original msg object preserved. Node doesn't set anything.</dd>
<dt>msg.eventId <span class="property-type">string</span></dt>
<dd>the eventId from the ban event.</dd>
</dl>
</li>
<li>Error