This module provides the full Node-RED application, with both the runtime and editor components built in.
httpAdmin
The express application for the Editor Admin API
httpNode
The express application for HTTP Nodes
server
The HTTP Server used by the runtime
init(httpServer, userSettings)
Initialise the Node-RED application.
Parameters:
| Name | Type | Description |
|---|---|---|
httpServer |
server
|
the HTTP server object to use |
userSettings |
Object
|
an object containing the runtime settings |
start() → {Promise}
Start the Node-RED application.
Returns:
- Type:
-
Promise
- resolves when complete
stop() → {Promise}
Stop the Node-RED application.
Returns:
- Type:
-
Promise
- resolves when complete
version() → {String}
Get the version of the runtime
Returns:
- Type:
-
String
- the runtime version