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 API Reference (markdown)

Nick O'Leary 2013-09-07 15:27:23 -07:00
parent 76d255fdea
commit 854cb970ea
1 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
API-Reference.md

@ -1,5 +1,5 @@
## Server
### [Nodes](API Server Nodes)
### Nodes
- [RED.nodes.Node](#server-Node) - the super class all Nodes extend.
- [node.send(msg)](#server-Node-send)
- [node.receive(msg)](#server-Node-receive)
@ -39,3 +39,30 @@
- RED.view.dirty(dirty)
- RED.sidebar.addTab(title,content)
- RED.notify(msg,type)
<a name="#wiki-server-Node" href="#server-Node">#</a> RED.nodes.<b>Node</b>
All nodes extend this class. It handles the wiring between nodes and other things. It should not be instantiated directly, rather [RED.nodes.createNode](#server-createNode) should be used.
<a name="#wiki-server-Node-send" href="#server-Node-send">#</a> node.<b>send</b>(<i>msg</i>)
<a name="#wiki-server-Node-receive" href="#server-Node-receive">#</a> node.<b>receive</b>(<i>msg</i>)
<a name="#wiki-server-Node-close" href="#server-Node-close">#</a> node.<b>close</b>()
<a name="#wiki-server-Node-log" href="#server-Node-log">#</a> node.<b>log</b>(<i>msg</i>)
<a name="#wiki-server-Node-warn" href="#server-Node-warn">#</a> node.<b>warn</b>(<i>msg</i>)
<a name="#wiki-server-Node-error" href="#server-Node-error">#</a> node.<b>error</b>(<i>msg</i>)
<a name="#wiki-server-createNode" href="#server-createNode">#</a> RED.nodes.<b>createNode</b>(<i>node</i>,<i>definition</i>)
<a name="#wiki-server-registerType" href="#server-registerType">#</a> RED.nodes.<b>registerType</b>(<i>type</i>,<i>node</i>)
<a name="#wiki-server-library-register" href="#server-library-register">#</a> RED.library.<b>register</b>(<i>type</i>)