Browse Source

docs(Spruce.once())

Ryan Chandler 5 years ago
parent
commit
5dff20c5b3
1 changed files with 10 additions and 0 deletions
  1. 10 0
      README.md

+ 10 - 0
README.md

@@ -219,6 +219,14 @@ Spruce.on('init', ({ store }) => {
 })
 ```
 
+* `Spruce.once(eventName, callback)` - this can be used to register an event listener that is only run **a single time**. This is useful for one time events, such as fetching HTML from the server when hovering over a button or similar.
+
+```js
+Spruce.once('event', () => {
+    // do something once...
+})
+```
+
 * `Spruce.off(eventName, callback)` - this can be used to unhook or de-register an event listener.
 
 ```js
@@ -227,6 +235,8 @@ var callback = () => {}
 Spruce.off('init', callback)
 ```
 
+> **Note**: When calling `Spruce.off()` directly, you **must** pass a named callback.
+
 You can also unhook a listener using the function returned by `Spruce.on()`. This is especially useful for anonymous function callbacks.
 
 ```js