1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00

Updated API Reference (markdown)

Nick O'Leary 2013-09-07 14:56:40 -07:00
parent be1d252c18
commit f7fa6e3f3c

@ -1,44 +1,41 @@
## Server
### Node creation
- RED.nodes.Node - the super class all Nodes extend.
- node.send(msg)
- node.receive(msg)
- node.close
- node.log(msg)
- node.warn(msg)
- node.error(msg)
- RED.nodes.createNode(node,definition)
- RED.nodes.registerType(type,node) -
- RED.library.register(type)
### [Nodes](API/Server/Nodes)
- [RED.nodes.Node](API/Server/Nodes#Node) - the super class all Nodes extend.
- [node.send(msg)](API/Server/Nodes#Node-send)
- [node.receive(msg)](API/Server/Nodes#Node-receive)
- [node.close](API/Server/Nodes#Node-close)
- [node.log(msg)](API/Server/Nodes#Node-log)
- [node.warn(msg)](API/Server/Nodes#Node-warn)
- [node.error(msg)](API/Server/Nodes#Node-error)
- [RED.nodes.createNode(node,definition)](API/Server/Nodes#createNode)
- [RED.nodes.registerType(type,node)](API/Server/Nodes#registerType)
- [RED.library.register(type)](API/Server/Nodes#library-register)
### Credentials
### [Credentials](API/Server/Credentials)
- RED.nodes.addCredentials(id,credentials)
- RED.nodes.getCredentials(id)
- RED.nodes.deleteCredentials(id)
### HTTP Server
### [HTTP Server](API/Server/HTTP Server)
- RED.server.app - the Express instance serving the editor UI
- RED.server.server - the server instance
## Client
### Validators
- RED.validators.number()
- RED.validators.regex(re)
### Node creation
### [Nodes](API/Client/Nodes)
- RED.nodes.registerType(type,node)
- RED.library.create({})
### Nodes
- RED.nodes.eachNode(cb)
- RED.nodes.eachLink(cb)
- RED.nodes.eachConfig(cb)
- RED.nodes.node(id)
### UI
### [Validators](API/Client/Validators)
- RED.validators.number()
- RED.validators.regex(re)
### [UI](API/Client/UI)
- RED.view.redraw
- RED.view.dirty(dirty)
- RED.sidebar.addTab(title,content)
- RED.notify(msg,type)