npm 包 gulp-watch-api 使用教程

简介

gulp-watch-api 是一个可以监视文件并在文件改变时运行任务的 npm 模块。它是基于 gulp-watch 创建的，但还提供了更多的功能和选项。

安装

使用 npm 可以很方便地安装 gulp-watch-api：

npm install gulp-watch-api --save-dev

使用方法

监视文件

要开始监视文件夹和文件，可以使用以下代码：

const watch = require('gulp-watch-api');

watch('src/**/*.js', () => {
  // 在此处编写运行任务的代码
});

这将监视 src 文件夹下所有的 .js 文件，并在文件更改时运行回调函数。

过滤文件

您可以使用 ignoreInitial 和 ignorePermissionErrors 选项来过滤初始文件和权限错误。例如，以下代码将忽略初始文件并在文件更改时运行回调函数：

watch('src/**/*.js', { ignoreInitial: true }, () => {
  // 在此处编写运行任务的代码
});

限制并发

如果您需要同时运行的任务数量有限，可以使用 tasksPerRun 选项。例如，以下代码将每次最多运行 2 个任务：

watch('src/**/*.js', { tasksPerRun: 2 }, () => {
  // 在此处编写运行任务的代码
});

使用事件

gulp-watch-api 还支持使用事件。例如，以下代码将在文件更改时触发 change 事件：

const watcher = watch('src/**/*.js');

watcher.on('change', () => {
  // 在此处编写运行任务的代码
});

自定义任务

要使用自定义任务，可以将回调函数中的代码替换为您的任务代码。例如，以下代码将运行名为 myTask 的 gulp 任务：

const gulp = require('gulp');
const watch = require('gulp-watch-api');

watch('src/**/*.js', () => {
  gulp.start('myTask');
});

结论

gulp-watch-api 是一个方便且易于使用的 npm 模块，用于监视文件并在文件更改时运行任务。通过结合选项和事件，您可以根据您的需求定制它，并提高您的工作效率。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/56585