frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2025-03-01 10:36:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tidy up more core node help text

Browse Source
This commit is contained in:
Nick O'Leary
2017-05-23 17:26:23 +01:00
parent 3d2e6aea7b
commit dfe1cd4f90
7 changed files with 65 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
nodes/core/core/58-debug.html
View File

@@ -19,18 +19,14 @@
</script>
<script type="text/x-red" data-help-name="debug">
<p>The Debug node can be connected to the output of any node. It can be used to display the output of any message
property in the debug tab of the sidebar. The default is to display <code>msg.payload</code>.</p>
<p>Each message will also display the date, time, node-id and the type of the chosen property.</p>
<p>The sidebar can be accessed under the options drop-down ( <i class="fa fa-bars"></i> ) in the top right corner.</p>
<p>The button to the right of the node will toggle its output on and off so you can de-clutter the debug window.</p>
<p>You can explore the received messages further by clicking on them. Numbers will be shown in decimal and hex and
as a timestamp if appropriate. Objects and arrays can be further expanded as required. Buffers may be able to be
shown as strings if possible.</p>
<p>Selecting the node-id of any particular message will highlight (in red) the debug node that reported it.
This is useful if you wire up multiple debug nodes.</p>
<p>The node can also be configured to send all messages to the console log (⇶).</p>
<p><b>Note: </b>In addition, any calls to <b>node.warn</b> or <b>node.error</b> will also appear in the debug tab.</p>
<p>Displays selected message properties in the debug sidebar tab and optionally the runtime log. By default it displays <code>msg.payload</code>.</p>
<h3>Details</h3>
<p>The debug sidebar provides a structured view of the messages it is sent, making it easier to understand their structure.</p>
<p>JavaScript objects and arrays can be collapsed and expanded as required. Buffer objects can be displayed as raw data or as a string if possible.</p>
<p>Alongside each message, the debug sidebar includes information about the time the message was received, the node that sent it and the type of the message.
Clicking on the source node id will reveal that node within the workspace.</p>
<p>The button on the node can be used to enable or disable its output. It is recommended to disable or remove any Debug nodes that are not being used.</p>
<p>The node can also be configured to send all messages to the runtime log.</p>
</script>
<script src="debug/view/debug-utils.js"></script>