mirror of
https://github.com/node-red/node-red.git
synced 2023-10-10 13:36:53 +02:00
Created API Reference (markdown)
parent
cb77a221a9
commit
be1d252c18
44
API-Reference.md
Normal file
44
API-Reference.md
Normal file
@ -0,0 +1,44 @@
|
||||
## 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)
|
||||
|
||||
### Credentials
|
||||
- RED.nodes.addCredentials(id,credentials)
|
||||
- RED.nodes.getCredentials(id)
|
||||
- RED.nodes.deleteCredentials(id)
|
||||
|
||||
### 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
|
||||
- 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
|
||||
- RED.view.redraw
|
||||
- RED.view.dirty(dirty)
|
||||
- RED.sidebar.addTab(title,content)
|
||||
- RED.notify(msg,type)
|
||||
|
Loading…
Reference in New Issue
Block a user