Add examples for debounce operator

nmuldavin · Dec 2, 2017 · c013ef3 · c013ef3
1 parent 0e28586
commit c013ef3
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/debounce.js b/src/debounce.js
@@ -2,6 +2,15 @@
  * [Debounces](https://davidwalsh.name/javascript-debounce-function) an Observable stream
  * by a specified number of milliseconds.
  *
+ * @example
+ * debounce(clickEvents, 300)
+ *
+ * @example
+ * // if available on Observable.prototype
+ * clickEvents
+ *   .debounce(300)
+ *   .map(handler)
+ *
  * @param  {Observable} input Input Observable
  * @param  {number}     ms    Milliseconds to debounce by
  * @return {Observable} Debounced Observable