frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
Code Issues Releases Wiki Activity

Updated Node Design Guidelines (markdown)

hbeeken 2014-11-03 02:54:06 -08:00
parent 31a2afb217
commit c2ccd8562e
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Node-Design-Guidelines.md

@ -1,6 +1,3 @@
### Messages
* [Message property conventions](https://github.com/node-red/node-red/wiki/Node-msg-Conventions)
### Nodes ### Nodes
There are three types of node. There are three types of node.
@ -9,6 +6,13 @@ There are three types of node.
- a **Function node** sits in the middle of a flow. It performs actions based on the incoming messages and passes on the resulting messages. One sub-type of Function node is a **Query node** that is used to retrieve data from an external API, such as a database query or a web services call. - a **Function node** sits in the middle of a flow. It performs actions based on the incoming messages and passes on the resulting messages. One sub-type of Function node is a **Query node** that is used to retrieve data from an external API, such as a database query or a web services call.
- an **Output node** sits at the end of a flow. It consumes the incoming messages and triggers an action. - an **Output node** sits at the end of a flow. It consumes the incoming messages and triggers an action.
### Conventions
(under development)
* [Message property conventions](https://github.com/node-red/node-red/wiki/Node-msg-Conventions)
- data in the node settings overwrites that in an incoming message
- If data in the incoming message is not valid, the node should......? (Question: in this case should the node issue a warning? or an error? and/or change its status? or ignore this silently?)
--- ---
Work in progress: Work in progress: