Skip to content

Commit

Permalink
fix(docs): fix docs for on/off/once methods
Browse files Browse the repository at this point in the history
and add missing rimraf dependency

fixes #4
  • Loading branch information
tunnckoCore committed Mar 12, 2017
1 parent 09cade0 commit a21d6b5
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 14 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ See [JSBin Example](http://jsbin.com/xeketuruto/edit?js,console).
**Params**

* `name` **{String}**: Type of event to listen for, or `'*'` for all events
* `handler` **{String}**: Function to call in response to given event
* `handler` **{Function}**: Function to call in response to given event
* `returns` **{Object}**: The `dush` instance for chaining

**Example**
Expand All @@ -165,7 +165,7 @@ See [JSBin Example](http://jsbin.com/teculorima/edit?js,console).
**Params**

* `name` **{String}**: Type of event to listen for, or `'*'` for all events
* `handler` **{String}**: Function to call in response to given event
* `handler` **{Function}**: Function to call in response to given event
* `returns` **{Object}**: The `dush` instance for chaining

**Example**
Expand Down Expand Up @@ -195,7 +195,7 @@ See [JSBin Example](http://jsbin.com/nujucoquvi/3/edit?js,console).
**Params**

* `name` **{String}**: Type of event to listen for, or `'*'` for all events
* `handler` **{String}**: Function to call in response to given event
* `handler` **{Function}**: Function to call in response to given event
* `returns` **{Object}**: The `dush` instance for chaining

**Example**
Expand Down Expand Up @@ -302,7 +302,7 @@ Copyright © 2015, 2017, [Charlike Mike Reagent](https://i.am.charlike.online).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on March 11, 2017._
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on March 12, 2017._
_Project scaffolded using [charlike][] cli._

[always-done]: https://github.com/hybridables/always-done
Expand Down
6 changes: 3 additions & 3 deletions dist/dush.common.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ function dush () {
*
* @name .on
* @param {String} `name` Type of event to listen for, or `'*'` for all events
* @param {String} `handler` Function to call in response to given event
* @param {Function} `handler` Function to call in response to given event
* @return {Object} The `dush` instance for chaining
* @api public
*/
Expand Down Expand Up @@ -124,7 +124,7 @@ function dush () {
*
* @name .once
* @param {String} `name` Type of event to listen for, or `'*'` for all events
* @param {String} `handler` Function to call in response to given event
* @param {Function} `handler` Function to call in response to given event
* @return {Object} The `dush` instance for chaining
* @api public
*/
Expand Down Expand Up @@ -168,7 +168,7 @@ function dush () {
*
* @name .off
* @param {String} `name` Type of event to listen for, or `'*'` for all events
* @param {String} `handler` Function to call in response to given event
* @param {Function} `handler` Function to call in response to given event
* @return {Object} The `dush` instance for chaining
* @api public
*/
Expand Down
6 changes: 3 additions & 3 deletions dist/dush.es.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ function dush () {
*
* @name .on
* @param {String} `name` Type of event to listen for, or `'*'` for all events
* @param {String} `handler` Function to call in response to given event
* @param {Function} `handler` Function to call in response to given event
* @return {Object} The `dush` instance for chaining
* @api public
*/
Expand Down Expand Up @@ -122,7 +122,7 @@ function dush () {
*
* @name .once
* @param {String} `name` Type of event to listen for, or `'*'` for all events
* @param {String} `handler` Function to call in response to given event
* @param {Function} `handler` Function to call in response to given event
* @return {Object} The `dush` instance for chaining
* @api public
*/
Expand Down Expand Up @@ -166,7 +166,7 @@ function dush () {
*
* @name .off
* @param {String} `name` Type of event to listen for, or `'*'` for all events
* @param {String} `handler` Function to call in response to given event
* @param {Function} `handler` Function to call in response to given event
* @return {Object} The `dush` instance for chaining
* @api public
*/
Expand Down
2 changes: 1 addition & 1 deletion dist/dush.umd.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"npm-run-all": "^4.0.1",
"nyc": "^10.1.2",
"pre-commit": "^1.2.2",
"rimraf": "^2.6.1",
"rollup": "^0.41.5",
"rollup-plugin-buble": "^0.15.0",
"rollup-plugin-gzip": "^1.0.0",
Expand Down
6 changes: 3 additions & 3 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export default function dush () {
*
* @name .on
* @param {String} `name` Type of event to listen for, or `'*'` for all events
* @param {String} `handler` Function to call in response to given event
* @param {Function} `handler` Function to call in response to given event
* @return {Object} The `dush` instance for chaining
* @api public
*/
Expand Down Expand Up @@ -124,7 +124,7 @@ export default function dush () {
*
* @name .once
* @param {String} `name` Type of event to listen for, or `'*'` for all events
* @param {String} `handler` Function to call in response to given event
* @param {Function} `handler` Function to call in response to given event
* @return {Object} The `dush` instance for chaining
* @api public
*/
Expand Down Expand Up @@ -168,7 +168,7 @@ export default function dush () {
*
* @name .off
* @param {String} `name` Type of event to listen for, or `'*'` for all events
* @param {String} `handler` Function to call in response to given event
* @param {Function} `handler` Function to call in response to given event
* @return {Object} The `dush` instance for chaining
* @api public
*/
Expand Down
6 changes: 6 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2378,6 +2378,12 @@ rimraf@^2.2.8, rimraf@^2.3.3, rimraf@^2.4.3, rimraf@^2.4.4, rimraf@^2.5.4:
dependencies:
glob "^7.0.5"

rimraf@^2.6.1:
version "2.6.1"
resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-2.6.1.tgz#c2338ec643df7a1b7fe5c54fa86f57428a55f33d"
dependencies:
glob "^7.0.5"

rollup-plugin-buble@^0.15.0:
version "0.15.0"
resolved "https://registry.yarnpkg.com/rollup-plugin-buble/-/rollup-plugin-buble-0.15.0.tgz#83c3e89c7fd2266c7918f41ba3980313519c7fd0"
Expand Down

0 comments on commit a21d6b5

Please sign in to comment.