mirror of
https://github.com/node-red/node-red.git
synced 2025-03-01 10:36:34 +00:00
Documentation updates for node-red and runtime modules
This commit is contained in:
@@ -15,7 +15,7 @@
|
||||
**/
|
||||
|
||||
/**
|
||||
* @namespace RED.library
|
||||
* @mixin @node-red/runtime_library
|
||||
*/
|
||||
|
||||
var runtime;
|
||||
@@ -32,7 +32,7 @@ var api = module.exports = {
|
||||
* @param {String} opts.type - the type of entry
|
||||
* @param {String} opts.path - the path of the entry
|
||||
* @return {Promise<String|Object>} - resolves when complete
|
||||
* @memberof RED.library
|
||||
* @memberof @node-red/runtime_library
|
||||
*/
|
||||
getEntry: function(opts) {
|
||||
return new Promise(function(resolve,reject) {
|
||||
@@ -71,7 +71,7 @@ var api = module.exports = {
|
||||
* @param {Object} opts.meta - any meta data associated with the entry
|
||||
* @param {String} opts.body - the body of the entry
|
||||
* @return {Promise} - resolves when complete
|
||||
* @memberof RED.library
|
||||
* @memberof @node-red/runtime_library
|
||||
*/
|
||||
saveEntry: function(opts) {
|
||||
return new Promise(function(resolve,reject) {
|
||||
@@ -98,7 +98,7 @@ var api = module.exports = {
|
||||
* @param {User} opts.user - the user calling the api
|
||||
* @param {String} opts.type - the type of entry
|
||||
* @return {Promise<Object>} - the entry listing
|
||||
* @memberof RED.library
|
||||
* @memberof @node-red/runtime_library
|
||||
*/
|
||||
getEntries: function(opts) {
|
||||
return new Promise(function(resolve,reject) {
|
||||
|
Reference in New Issue
Block a user