Documentation for each node?

General
1

Where can you find the "Detailed" documentation of the different Nodes that are available?

Here is an example: I'm using this "msg.result.push" property (because someone suggested it to me) but I can't find any documentation on the different propertys that might be available for the different nodes.

2

Nodes are catalogued at flows.nodered.org. There is a link to github too where you can examine the source code and any issues raised against the node.

The information shown there for each node is also available as the help in the right hand column of the editor.

Some nodes include example flows. Look in Import | Examples for the node name.

3

4 places to look (5 if you include the examples as jbudd points out):

  1. Firstly in the help panel after selecting an instance of the node you are interested in.
  2. As jbudd points out, the node's readme file should contain all of the essential information and pointers to more documentation if available. That readme comes from the source package - usually but not exclusively on GitHub.
  3. Some more complex nodes may include a built-in help site. uibuilder does this for example.
  4. On the GitHub/GitLab page for the node, there may be a WIKI or even something like a GitHub pages site. For example, the same documentation available in node-red for uibuilder is available at https://totallyinformation.github.io/node-red-contrib-uibuilder as well and there is further information in the wiki at https://github.com/TotallyInformation/node-red-contrib-uibuilder/wiki.
4

Which node does the message containing result come from?

5

OK, after looking at this again and trying to figure out what is actually happening this is how I think it is working. Please correct me if I'm worng as i am trying to learn.

In a series of http request my first function node has this code.

msg.result = [];  - This just creates an ARRAY
msg.result.push(msg.payload) - Then this line pushes the msg.payload into the array as an OBJECT

Now if I add another function node with this code


msg.result.push(msg.payload) - this just appends another Object into the ARRAY

So am I thinking correctly or can someone explain to me more detail.

Thanks

6

That is correct, assuming msg.payload is an object. If msg.payload is a number, String, etc then that will be pushed into the array.

7

Thanks that really helps me to understand much better.

8

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.