Skip to content

Commit

Permalink
Aligned all event documentation with actual behavior
Browse files Browse the repository at this point in the history
  • Loading branch information
juriejan committed May 25, 2017
1 parent b9b8257 commit 3c92146
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ var gaze = new Gaze(pattern, options, callback);
#### Events

* `ready(watcher)` When files have been globbed and watching has begun.
* `all(event, filepath)` When an `added`, `changed` or `deleted` event occurs.
* `all(event, filepath)` When an `added`, `changed`, `renamed` or `deleted` event occurs.
* `added(filepath)` When a file has been added to a watch directory.
* `changed(filepath)` When a file has been changed.
* `deleted(filepath)` When a file has been deleted.
Expand All @@ -132,7 +132,7 @@ var gaze = new Gaze(pattern, options, callback);
#### Methods

* `emit(event, [...])` Wrapper for the EventEmitter.emit.
`added`|`changed`|`deleted` events will also trigger the `all` event.
`added`|`changed`|`renamed`|`deleted` events will also trigger the `all` event.
* `close()` Unwatch all files and reset the watch instance.
* `add(patterns, callback)` Adds file(s) patterns to be watched.
* `remove(filepath)` removes a file or directory from being watched. Does not
Expand Down

0 comments on commit 3c92146

Please sign in to comment.