Skip to content

Commit

Permalink
Clarifications about .watch() paths arg
Browse files Browse the repository at this point in the history
  • Loading branch information
es128 committed Oct 16, 2015
1 parent 3760112 commit 625fe8e
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ chokidar.watch('.', {ignored: /[\/\\]\./}).on('all', function(event, path) {
// Example of a more typical implementation structure:

// Initialize watcher
var watcher = chokidar.watch('file, dir, or glob', {
var watcher = chokidar.watch('file, dir, glob, or array', {
ignored: /[\/\\]\./,
persistent: true
});
Expand Down Expand Up @@ -136,8 +136,11 @@ chokidar.watch('file', {

## API

`chokidar.watch(paths, options)` — takes one or more paths (which may be paths
to files, dirs to be watched recursively, or glob patterns) and options:
`chokidar.watch(paths, [options])`

* `paths` (string or array of strings). Paths to files, dirs to be watched
recursively, or glob patterns.
* `options` (object) Options object as defined below:

#### Persistence

Expand Down

0 comments on commit 625fe8e

Please sign in to comment.