gulp.watch()

gulp.watch()介绍

监听 globs 并在发生更改时运行任务。任务与任务系统的其余部分被统一处理。

gulp.watch()用法

const { watch } = require('gulp');

watch(['input/*.js', '!input/something.js'], function(cb) {
  // body omitted
  cb();
}); 

gulp.watch()函数原型

watch(globs, [options], [task])

参数

返回值

chokidar 的一个实例，用于对监听设置进行细粒度控制。

可能出现的错误

当以 globs 形式传递非字符串或带有任何非字符串的数组时，将抛出一个错误，并提示 "Non-string provided as watch path"。

当字符串或数组作为 task 传递时，会抛出一个错误，提示 "watch task has to be a function (optionally generated by using gulp.parallel or gulp.series)"（ watch 任务必须是一个函数(可以选择使用 gulp.parallel 或 gulp.series 生成))。

选项

Chokidar 实例

watch() 方法返回 chokidar 的底层实例，提供对监听设置的细粒度控制。最常用来注册提供更改文件的 path 或 stats 的单个事件处理程序。

当直接使用 chokidar 实例时，您将无法访问任务系统集成，包括异步完成、队列和延迟

const { watch } = require('gulp');

const watcher = watch(['input/*.js']);

watcher.on('change', function(path, stats) {
  console.log(`File ${path} was changed`);
});

watcher.on('add', function(path, stats) {
  console.log(`File ${path} was added`);
});

watcher.on('unlink', function(path, stats) {
  console.log(`File ${path} was removed`);
});

watcher.close();

watcher.on(eventName, eventHandler)

注册 eventHandler 函数，当指定的事件发生时调用该函数。

watcher.close()

关闭文件监听器。一旦关闭，就不会再发出任何事件。

watcher.add(globs)

向已经运行的监听器实例添加额外的 globs。

watcher.unwatch(globs)

删除正在被监听的 globs，而监视程序继续使用剩余的路径。