More api documentation updates

This commit is contained in:
Nick O'Leary
2019-01-28 14:40:24 +00:00
parent 2e063f91bc
commit e0bb03a53f
7 changed files with 109 additions and 4 deletions

View File

@@ -122,6 +122,13 @@ module.exports = {
*/
util: redUtil.util,
/**
* This provides access to the internal nodes module of the
* runtime.
*
* @memberof node-red
*/
get nodes() { return runtime._.nodes },
/**
@@ -131,6 +138,12 @@ module.exports = {
*/
events: runtime.events,
/**
* This provides access to the internal settings module of the
* runtime.
*
* @memberof node-red
*/
get settings() { return runtime._.settings },
@@ -145,18 +158,21 @@ module.exports = {
/**
* The express application for the Editor Admin API
* @type ExpressApplication
* @memberof node-red
*/
get httpAdmin() { return api.httpAdmin },
/**
* The express application for HTTP Nodes
* @type ExpressApplication
* @memberof node-red
*/
get httpNode() { return runtime.httpNode },
/**
* The HTTP Server used by the runtime
* @type HTTPServer
* @memberof node-red
*/
get server() { return server },
@@ -170,6 +186,7 @@ module.exports = {
/**
* The editor authentication api.
* @see @node-red/editor-api_auth
* @memberof node-red
*/
auth: api.auth