Documentation updates for node-red and runtime modules

packages/node_modules/@node-red/runtime/lib/api/projects.js

@@ -15,7 +15,7 @@
  **/
 
 /**
- * @namespace RED.projects
+ * @mixin @node-red/runtime_projects
  */
 
 var runtime;
@@ -33,7 +33,7 @@ var api = module.exports = {
     * @param {Object} opts
     * @param {User} opts.user - the user calling the api
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     listProjects: function(opts) {
         return runtime.storage.projects.listProjects(opts.user).then(function(list) {
@@ -57,7 +57,7 @@ var api = module.exports = {
     * @param {User} opts.user - the user calling the api
     * @param {Object} opts.project - the project information
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     createProject: function(opts) {
         return runtime.storage.projects.createProject(opts.user, opts.project)
@@ -70,7 +70,7 @@ var api = module.exports = {
     * @param {String} opts.id - the id of the project to initialise
     * @param {Object} opts.project - the project information
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     initialiseProject: function(opts) {
         // Initialised set when creating default files for an empty repo
@@ -82,7 +82,7 @@ var api = module.exports = {
     * @param {Object} opts
     * @param {User} opts.user - the user calling the api
     * @return {Promise<Object>} - the active project
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     getActiveProject: function(opts) {
         return Promise.resolve(runtime.storage.projects.getActiveProject(opts.user));
@@ -94,7 +94,7 @@ var api = module.exports = {
     * @param {User} opts.user - the user calling the api
     * @param {String} opts.id - the id of the project to activate
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     setActiveProject: function(opts) {
         var currentProject = runtime.storage.projects.getActiveProject(opts.user);
@@ -111,7 +111,7 @@ var api = module.exports = {
     * @param {User} opts.user - the user calling the api
     * @param {String} opts.id - the id of the project to get
     * @return {Promise<Object>} - the project metadata
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     getProject: function(opts) {
         return runtime.storage.projects.getProject(opts.user, opts.id)
@@ -124,7 +124,7 @@ var api = module.exports = {
     * @param {String} opts.id - the id of the project to update
     * @param {Object} opts.project - the project information
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     updateProject: function(opts) {
         return runtime.storage.projects.updateProject(opts.user, opts.id, opts.project);
@@ -136,7 +136,7 @@ var api = module.exports = {
     * @param {User} opts.user - the user calling the api
     * @param {String} opts.id - the id of the project to update
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     deleteProject: function(opts) {
         return runtime.storage.projects.deleteProject(opts.user, opts.id);
@@ -149,7 +149,7 @@ var api = module.exports = {
     * @param {String} opts.id - the id of the project
     * @param {Boolean} opts.remote - whether to include status of remote repos
     * @return {Promise<Object>} - the project status
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     getStatus: function(opts) {
         return runtime.storage.projects.getStatus(opts.user, opts.id, opts.remote)
@@ -162,7 +162,7 @@ var api = module.exports = {
     * @param {String} opts.id - the id of the project
     * @param {Boolean} opts.remote - whether to return remote branches (true) or local (false)
     * @return {Promise<Object>} - a list of the local branches
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     getBranches: function(opts) {
         return runtime.storage.projects.getBranches(opts.user, opts.id, opts.remote);
@@ -175,7 +175,7 @@ var api = module.exports = {
     * @param {String} opts.id - the id of the project
     * @param {String} opts.branch - the name of the branch
     * @return {Promise<Object>} - the status of the branch
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     getBranchStatus: function(opts) {
         return runtime.storage.projects.getBranchStatus(opts.user, opts.id, opts.branch);
@@ -189,7 +189,7 @@ var api = module.exports = {
     * @param {String} opts.branch - the name of the branch
     * @param {Boolean} opts.create - whether to create the branch if it doesn't exist
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     setBranch: function(opts) {
         return runtime.storage.projects.setBranch(opts.user, opts.id, opts.branch, opts.create)
@@ -203,7 +203,7 @@ var api = module.exports = {
     * @param {String} opts.branch - the name of the branch
     * @param {Boolean} opts.force - whether to force delete
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     deleteBranch: function(opts) {
         return runtime.storage.projects.deleteBranch(opts.user, opts.id, opts.branch, false, opts.force);
@@ -216,7 +216,7 @@ var api = module.exports = {
     * @param {String} opts.id - the id of the project
     * @param {String} opts.message - the message to associate with the commit
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     commit: function(opts) {
         return runtime.storage.projects.commit(opts.user, opts.id,{message: opts.message});
@@ -229,7 +229,7 @@ var api = module.exports = {
     * @param {String} opts.id - the id of the project
     * @param {String} opts.sha - the sha of the commit to return
     * @return {Promise<Object>} - the commit details
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     getCommit: function(opts) {
         return runtime.storage.projects.getCommit(opts.user, opts.id, opts.sha);
@@ -243,7 +243,7 @@ var api = module.exports = {
     * @param {String} opts.limit - limit how many to return
     * @param {String} opts.before - id of the commit to work back from
     * @return {Promise<Array>} - an array of commits
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     getCommits: function(opts) {
         return runtime.storage.projects.getCommits(opts.user, opts.id, {
@@ -258,7 +258,7 @@ var api = module.exports = {
     * @param {User} opts.user - the user calling the api
     * @param {String} opts.id - the id of the project
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     abortMerge: function(opts) {
         return runtime.storage.projects.abortMerge(opts.user, opts.id);
@@ -272,7 +272,7 @@ var api = module.exports = {
     * @param {String} opts.path - the path of the file being merged
     * @param {String} opts.resolutions - how to resolve the merge conflict
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     resolveMerge: function(opts) {
         return runtime.storage.projects.resolveMerge(opts.user, opts.id, opts.path, opts.resolution);
@@ -284,7 +284,7 @@ var api = module.exports = {
     * @param {User} opts.user - the user calling the api
     * @param {String} opts.id - the id of the project
     * @return {Promise<Object>} - the file listing
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     getFiles: function(opts) {
         return runtime.storage.projects.getFiles(opts.user, opts.id);
@@ -298,7 +298,7 @@ var api = module.exports = {
     * @param {String} opts.path - the path of the file
     * @param {String} opts.tree - the version control tree to use
     * @return {Promise<String>} - the content of the file
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     getFile: function(opts) {
         return runtime.storage.projects.getFile(opts.user, opts.id,opts.path,opts.tree);
@@ -311,7 +311,7 @@ var api = module.exports = {
     * @param {String} opts.id - the id of the project
     * @param {String|Array} opts.path - the path of the file, or an array of paths
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     stageFile: function(opts) {
         return runtime.storage.projects.stageFile(opts.user, opts.id, opts.path);
@@ -324,7 +324,7 @@ var api = module.exports = {
     * @param {String} opts.id - the id of the project
     * @param {String} opts.path - the path of the file. If not set, all staged files are unstaged
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     unstageFile: function(opts) {
         return runtime.storage.projects.unstageFile(opts.user, opts.id, opts.path);
@@ -337,7 +337,7 @@ var api = module.exports = {
     * @param {String} opts.id - the id of the project
     * @param {String} opts.path - the path of the file
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     revertFile: function(opts) {
         return runtime.storage.projects.revertFile(opts.user, opts.id,opts.path)
@@ -351,7 +351,7 @@ var api = module.exports = {
     * @param {String} opts.path - the path of the file
     * @param {String} opts.type - the type of diff
     * @return {Promise<Object>} - the requested diff
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     getFileDiff: function(opts) {
         return runtime.storage.projects.getFileDiff(opts.user, opts.id, opts.path, opts.type);
@@ -363,7 +363,7 @@ var api = module.exports = {
     * @param {User} opts.user - the user calling the api
     * @param {String} opts.id - the id of the project
     * @return {Promise<Object>} - a list of project remotes
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     getRemotes: function(opts) {
         return runtime.storage.projects.getRemotes(opts.user, opts.id);
@@ -379,7 +379,7 @@ var api = module.exports = {
     * @param {String} opts.remote.name - the name of the remote
     * @param {String} opts.remote.url - the url of the remote
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     addRemote: function(opts) {
         return runtime.storage.projects.addRemote(opts.user, opts.id, opts.remote)
@@ -392,7 +392,7 @@ var api = module.exports = {
     * @param {String} opts.id - the id of the project
     * @param {String} opts.remote - the name of the remote
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     removeRemote: function(opts) {
         return runtime.storage.projects.removeRemote(opts.user, opts.id, opts.remote);
@@ -406,7 +406,7 @@ var api = module.exports = {
     * @param {Object} opts.remote - the remote metadata
     * @param {String} opts.remote.name - the name of the remote
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     updateRemote: function(opts) {
         return runtime.storage.projects.updateRemote(opts.user, opts.id, opts.remote.name, opts.remote)
@@ -417,7 +417,7 @@ var api = module.exports = {
     * @param {Object} opts
     * @param {User} opts.user - the user calling the api
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     pull: function(opts) {
         return runtime.storage.projects.pull(opts.user, opts.id, opts.remote, opts.track, opts.allowUnrelatedHistories);
@@ -431,7 +431,7 @@ var api = module.exports = {
     * @param {String} opts.remote - the name of the remote
     * @param {String} opts.track - whether to set the remote as the upstream
     * @return {Promise<Object>} - resolves when complete
-    * @memberof RED.projects
+    * @memberof @node-red/runtime_projects
     */
     push: function(opts) {
         return runtime.storage.projects.push(opts.user, opts.id, opts.remote, opts.track);