README.md

gulp-sane-watch

Version: 3.0.4

Installation

Run npm install gulp-sane-watch

Usage

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

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

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

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

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

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

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');
        }
    });
});

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

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

API

saneWatch(glob, [options, callback])

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)