API documentation updates

This commit is contained in:
Nick O'Leary
2018-12-05 13:00:25 +00:00
parent ee47646cf7
commit 8e1c15419c
7 changed files with 124 additions and 62 deletions

View File

@@ -108,13 +108,38 @@ module.exports = {
})
},
/**
* Logging utilities
* @see @node-red/util_log
* @memberof node-red
*/
log: redUtil.log,
/**
* General utilities
* @see @node-red/util_util
* @memberof node-red
*/
util: redUtil.util,
get nodes() { console.log("Deprecated use of RED.nodes - refer to API documentation on RED.runtime.nodes"); return runtime._.nodes },
get events() { console.log("Deprecated use of RED.events - refer to API documentation on RED.runtime.events"); return runtime.events },
/**
* Runtime events emitter
* @see @node-red/runtime_events
* @memberof node-red
*/
events: runtime.events,
get settings() { return runtime._.settings },
/**
* Get the version of the runtime
* @return {String} - the runtime version
* @function
* @memberof node-red
*/
get version() { return runtime._.version },