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
Page: Query node feature definitions
Pages
API Reference Architecture Overview Architecture: Cluster Multi Process Contribution Process Dashboard layout tool Definitions Deprecated: Message properties overriding set node properties Design Notes Design: dynamic palette Design: API Token management Design: CLI tool to produce a node skeleton Design: Concurrent editing Design: Custom Node admin route handling Design: Dynamic MQTT node Design: Dynamic node's icon Design: Editable port labels Design: Editor Events Design: Editor Themes Design: Editor UI Customisation Design: Encryption of credentials Design: Enhancements to Split Join nodes Design: Flow Linter Design: Flow Manipulation API Design: Flow file format v2 Design: Function Library node Design: Library Sidebar Design: Logging Framework Design: Node Generator Design: Node Messaging API Design: Node blacklist whitelist function Design: Node module lifecycle Design: Node settings Design: Palette Management UI Design: Persistable Context Design: Platform Specific Nodes Design: Projects Design: Runnable Project Design: Runtime Editor Split Design: Runtime Events Design: Runtime extension points Design: Subflow Enhancements Design: Subflow Instance properties Design: Subflow Node modules Design: Usage telemetry Design: Using environment variables Design: Version Control Design: adminAuth User Management Design: external file for function and templates nodes Design: i18n de Design: i18n Design: msg.parts description of usage Design: multiuser Design: subflows vNext Design: subflows Design:Shared Global Context Editor Mouse Actions Editor Runtime API Flow Format Flow testing Home Input node feature definitions Live runtime information Node Design Guidelines Node documentation guide Node msg Conventions Output node feature definitions Pluggable Message Routing Query node feature definitions ReadMe Raspberry Pi Advanced Runtime Editor Comms protocol Technical Interchange 2018 04 13 Technical Interchange Meetings Testing UI testing Watch node feature definitions Web Nodes outline adminAuth Credential Authentication dynamic palette join in auto mode npm installable nodes
6 Query node feature definitions
zobalogh edited this page 2014-10-30 04:18:37 -07:00
Table of Contents

This page defines the features and design conventions that each query node should adhere to. The page is currently under development and changes to its contents are possible. Once the behaviour is agreed upon, these conventions are going to be migrated onto the Node-RED website for easy reference. Only the website reference should be used as a blueprint.

Query nodes MUST:

  • Always produce an output msg upon receiving an incoming msg
  • Send out a NULL msg.payload if for some reason they cannot provide the appropriate payload (example: data not available yet)
  • Upon receiving a NULL message payload, they should.... TODO

Query nodes SHOULD:

  • Have clearly defined behaviour that determines how the incoming msg object is manipulated and then forwarded

  • Try to be as stateless as possible (same behaviour regardless of say initialization properties or any other state)

  • MULTIPLE MESSAGE/CLONING BEHAVIOUR TO BE DEFINED

  • Clean up their state upon close node.on("close", function() {}

  • Report errors using node.warn() or node.error() if the external systems are in an unexpected state/behaviour

Query nodes COULD:

  • MULTIPLE MESSAGE/CLONING BEHAVIOUR TO BE DEFINED