added to Global API

Author: User

API.js

@@ -14,7 +14,10 @@ const GlobalConfig = [
 ]
 
 const GlobalAPI = [
-    G_API.EXTEND
+    G_API.EXTEND,
+    G_API.NEXT_TICK,
+    G_API.SET,
+    G_API.DELETE
 ]
 
 

apis/globalapi.js

@@ -35,14 +35,52 @@ const EXTEND = {
 }
 
 const NEXT_TICK = {
-
+    category: 'Global API',
+    name: 'Vue.nextTick([callback, context])',
+    arguments: [
+        `{Function} [callback]`,
+        `{Object} [context]`
+    ],
+    usage: `Defer the callback to be executed after the next DOM update cycle.
+                        Use it immediately after you've changed some data to wait
+                        for the DOM update.`,
+    example: `${colorComment('// modify data')}
+                        vm.msg = ${chalk.green("'Hello'")}
+                        Vue.nextTick(${chalk.blue('function')} () {
+                            ${colorComment('// DOM update')}
+                        })`
 }
 
 const SET = {
-
+    category: 'Global API',
+    name: 'Vue.set(target,key,value)',
+    arguments:[
+        `{Object | Array} target`,
+        `{string | number} key`,
+        `{any} value`
+    ],
+    returns: 'the set value',
+    usage: `Set a property on an object. If the object is reactive, ensure
+                        the property is created as a reactive property and
+                        trigger view updates. This is primarily used to get around
+                        the limitation that Vue cannot detect property additions.
+                        ${chalk.redBright.bold(`Note the object cannot be a Vue instance, or the root data
+                        object of a Vue instance.`)}`
 }
 
 const DELETE = {
+    category: 'Global API',
+    name: 'Vue.delete(target,key)',
+    arguments: [
+        `{Object | Array} target`,
+        `{string | number} key`
+    ],
+    usage: `Delete a property on an object. If the object is reactive, ensure the
+                        deletion triggers view updates. This is primarily used to get
+                        around the limitation that Vue cannot detect property deletions,
+                        but you should rarely need to use it.
+                        ${chalk.redBright.bold(`The target object cannot be a Vue instance, or the root data 
+                        object of a Vue instance.`)}`
 
 }
 
@@ -75,5 +113,8 @@ const VERSION = {
 }
 
 module.exports = {
-    EXTEND
+    EXTEND,
+    NEXT_TICK,
+    SET,
+    DELETE
 }

logfunctions/logglobalapi.js

@@ -8,12 +8,12 @@ module.exports = {
                     ${chalk.green('Category:')} ${obj.category}
                     ${chalk.green('Name:')} ${obj.name + '\n'}
                     * Arguments: 
-                        ${obj.arguments.map(arg => {
-                            return `* ${args(arg)}`
-                        })}
-                    
+                        ${obj.arguments.map((arg, index) => {
+                            return `${index+1} ${args(arg)} `
+                        }).join(" ")}
+                    ${obj.returns ? `* Returns: ${obj.returns}` : ''}
                     * Usage: ${obj.usage}
-                    * Example: ${obj.example}
+                    ${obj.example ? `* Example: ${obj.example}` : ''} 
                 `
             )
     }

vue-help.js

@@ -66,7 +66,25 @@ V.command('productionTip', 'Outputs "Global Config: #productionTip"').action(fun
 // Global API
 
 V.command('extend', 'Outputs "Global API: #Vue.extend(options)"').action(function(args, callback){
-    const ex = ga[0]
-    this.log(LGA.logGlobalAPI(ex))
+    const ext = ga[0]
+    this.log(LGA.logGlobalAPI(ext))
+    callback()
+})
+
+V.command('nextTick', 'Outputs "Global API: #Vue.nextTick([callback,context])"').action(function(args, callback){
+    const nextTick = ga[1]
+    this.log(LGA.logGlobalAPI(nextTick))
+    callback()
+})
+
+V.command('set', 'Outputs "Global API: #Vue.set(target,key,value)"').action(function(args, callback){
+    const st = ga[2]
+    this.log(LGA.logGlobalAPI(st))
+    callback()
+})
+
+V.command('delete', 'Outputs "Global API: #Vue.delete(target,key)"').action(function(args, callback){
+    const dlt = ga[3]
+    this.log(LGA.logGlobalAPI(dlt))
     callback()
 })