add once method

yangmingshan · Nov 11, 2016 · 1660fb5 · 1660fb5
1 parent d237b13
commit 1660fb5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -20,13 +20,14 @@ You don't need to do this when using global script tags.
 // ...
 created() {
   this.$bus.on('add-todo', this.addTodo);
+  this.$bus.once('once', () => console.log('This listener will only fire once'));
 },
 beforeDestroy() {
   this.$bus.off('add-todo', this.addTodo);
 },
 methods: {
   addTodo(newTodo) {
-    this.todos.push(newTodo)
+    this.todos.push(newTodo);
   }
 }
 ```
@@ -36,10 +37,12 @@ methods: {
 methods: {
   addTodo() {
     this.$bus.emit('add-todo', { text: this.newTodoText });
+    this.$bus.emit('once');
     this.newTodoText = '';
   }
 }
 ```
+*Note: `$bus.on` `$bus.once` `$bus.off` `$bus.emit` are aliases for `$bus.$on` `$bus.$once` `$bus.$off` `$bus.$emit`. See the [API](http://vuejs.org/v2/api/#Instance-Methods-Events) for more detail.*
 
 ## License
 [MIT](http://opensource.org/licenses/MIT)
diff --git a/index.js b/index.js
@@ -19,6 +19,11 @@
           return this.$on;
         }
       },
+      once: {
+        get: function() {
+          return this.$once;
+        }
+      },
       off: {
         get: function() {
           return this.$off;

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "vue-bus",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "A event bus for Vue.js",
   "main": "index.js",
   "scripts": {