gulp-sane-watch [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]

Version: 3.0.4

Installation

Run npm install gulp-sane-watch

Usage

``js
const gulp = require('gulp');
const saneWatch = require('gulp-sane-watch');

gulp.task('watch', () => {
saneWatch('css/*/.css', () => {
gulp.start('styles');
});
});
`

`js
const gulp = require('gulp');
const saneWatch = require('gulp-sane-watch');

gulp.task('watch', () => {
saneWatch('css/*/.css', { debounce: 300 }, () => {
gulp.start('styles');
});
});
`

`js
const gulp = require('gulp');
const saneWatch = require('gulp-sane-watch');

gulp.task('watch', () => {
saneWatch('css/*/.css', {
events: ['onChange', 'onAdd']
}, () => {
gulp.start('styles');
});
});
`

`js
const gulp = require('gulp');
const saneWatch = require('gulp-sane-watch');

gulp.task('watch', () => {
saneWatch('css/*/.css', {
debounce: 300,
onChange: () => {
gulp.start('change');
},
onAdd: () => {
gulp.start('add');
},
onDelete: () => {
gulp.start('delete');
}
});
});
`

`js
const gulp = require('gulp');
const saneWatch = require('gulp-sane-watch');

gulp.task('watch', () => {
saneWatch('css/*/.css', {
saneOptions: {
poll: true
}
}, () => {
gulp.start('styles');
});
});
`

API

$3

#### glob
- Type: String | Array

Creates watcher that will spy on files that were matched by glob which can be a
node-glob string or array of strings.

#### options

##### saneOptions

This object is passed to sane options directly (refer to sane documentation).

##### debounce
- Type: Integer
- Unit: milliseconds
- Default: 0

##### verbose
- Type: Boolean
- Default: true

##### onChange, onAdd, onDelete, onReady
- Type: function(filename, path, stat)

This function is called, when some group of events is happens on file-system.

onDelete function parameter list does not include stat parameter.

onReady function parameter list does not include any parameter.

##### events
- Type: Array
- Default: ['onChange', 'onAdd', 'onDelete']

List of events, that should be watched by gulp-sane-watch. Contains event names from sane.

#### callback
- Type: function(filename, path, stat)`

This function is called, when some group of events is happens on file-system.

License

MIT © 2021 Gergely Kovács (gg.kovacs@gmail.com)

[npm-image]: https://badge.fury.io/js/gulp-sane-watch.svg
[npm-url]: https://npmjs.org/package/gulp-sane-watch
[travis-image]: https://travis-ci.com/ggkovacs/gulp-sane-watch.svg?branch=master
[travis-url]: https://travis-ci.com/ggkovacs/gulp-sane-watch
[daviddm-image]: https://david-dm.org/ggkovacs/gulp-sane-watch.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/ggkovacs/gulp-sane-watch