API Reference

Server

Nodes

• 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](API/Server/HTTP Server)

• RED.server.app - the Express instance serving the editor UI
• RED.server.server - the server instance

Client

Nodes

• RED.nodes.registerType(type,node)
• RED.library.create({})
• RED.nodes.eachNode(cb)
• RED.nodes.eachLink(cb)
• RED.nodes.eachConfig(cb)
• RED.nodes.node(id)

Validators

• RED.validators.number()
• RED.validators.regex(re)

UI

• RED.view.redraw
• RED.view.dirty(dirty)
• RED.sidebar.addTab(title,content)
• RED.notify(msg,type)

# RED.nodes.Node

All nodes extend this class. It handles the wiring between nodes and other things. It should not be instantiated directly, rather RED.nodes.createNode should be used.

# 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)