added Instance Methods/Events APIs

Author: User

apis/instanceevents.js

@@ -5,10 +5,60 @@ const colorPrimitive = custom.colorPrimitive
 const colorError = custom.colorError
 const colorArgs = custom.colorArgs
 
-const VM_$ON = {}
-const VM_$ONCE = {}
-const VM_$OFF = {}
-const VM_$EMIT = {}
+const cat = 'Instance Methods/Events'
+
+const VM_$ON = {
+    category: cat,
+    name: `vm.$on(event, callback)`,
+    arguments:[
+        `{string | Array<string>} event`,
+        `{Function} callback`
+    ],
+    usage: `Listen for a custom event on the current vm.
+                        Events can be triggered by ${colorArgs(`vm.$emit`)}. The callback will receive
+                        all the additional arguments passed into these event-triggering methods.`,
+    example: `
+                        vm.$on(${chalk.green(`'test'`)}, ${chalk.blue(`function`)} (msg) {
+                            ${chalk.green(`console`)}.log(msg)
+                        })
+                        vm.$emit(${chalk.green(`'test'`)}, ${chalk.green(`'hi'`)})
+                        ${colorComment(`// -> "hi"`)}
+    `
+}
+const VM_$ONCE = {
+    category: cat,
+    name: `vm.$once(event,callback)`,
+    arguments:[
+        `{string} event`,
+        `{Function} callback`
+    ],
+    usage: `Listen for a custom event, but only once.
+                        The listener will be removed once it triggers for the first time.`
+}
+const VM_$OFF = {
+    category: cat,
+    name: `vm.$off([event,callback])`,
+    arguments: [
+        `{string} [event]`,
+        `{Function} [callback]`
+    ],
+    usage: `Remove custom event listener(s).
+                        * If no arguments are provided, remove all event listeners;
+                        * If only the event is provided, remove all listeners for that event;
+                        * If both event and callback are given, remove the listener
+                            for that specific callback only.
+`
+}
+const VM_$EMIT = {
+    category: cat,
+    name: `vm.$emit(event,[...args])`,
+    arguments: [
+        `{string} event`,
+        `[...args]`
+    ],
+    usage: `Trigger an event on the current instance. Any additional
+                        arguments will be passed into the listener’s callback function.`
+}
 
 module.exports = {
     VM_$ON,

vue-help.js

@@ -466,3 +466,29 @@ V.command('vm.$delete', 'Instance Methods/Data: #vm.$delete(target,key)').action
 })
 
 // Instance Methods/Events
+
+V.command('vm.$on', 'Instance Methods/Events: #vm.$on(event,callback)').action(function(args, callback){
+    const w = im[0]
+    this.log(LI.logInstance(w))
+    callback()
+})
+
+V.command('vm.$once', 'Instance Methods/Events: #vm.$once(event,callback)').action(function(args, callback){
+    const w = im[1]
+    this.log(LI.logInstance(w))
+    callback()
+})
+
+V.command('vm.$off', 'Instance Methods/Events: #vm.$off([event,callback])').action(function(args, callback){
+    const w = im[2]
+    this.log(LI.logInstance(w))
+    callback()
+})
+
+V.command('vm.$emit', 'Instance Methods/Events: #vm.$delete(event,[...args])').action(function(args, callback){
+    const w = im[3]
+    this.log(LI.logInstance(w))
+    callback()
+})
+
+// Instance Methods/Lifecycle