src()

优质

小牛编辑

129浏览

2023-12-01

创建一个流，用于从文件系统读取 Vinyl 对象。

注：BOMs(字节顺序标记)在 UTF-8 中没有任何作用，除非使用 removeBOM 选项禁用，否则 src() 将从读取的 UTF-8 文件中删除BOMs。

用法

const { src, dest } = require('gulp');

function copy() {
  return src('input/*.js')
    .pipe(dest('output/'));
}

exports.copy = copy;

src(globs, [options])

参数类型描述

globs string
array Globs to watch on the file system.

options

object

在下面的返回值

返回一个可以在管道的开始或中间使用的流，用于根据给定的 globs 添加文件。

当 globs 参数只能匹配一个文件(如 foo/bar.js)而且没有找到匹配时，会抛出一个错误，提示 "File not found with singular glob"。若要抑制此错误，请将 allowEmpty 选项设置为 true。

当在 globs 中给出一个无效的 glob 时，抛出一个错误，并显示 "Invalid glob argument"。

对于接受函数的选项，传递的函数将与每个 Vinyl 对象一起调用，并且必须返回另一个列出类型的值。

名称	类型	默认值	描述
buffer	boolean function	true	当为 true 时，文件内容被缓冲到内存中。如果为false，Vinyl 对象的 `contents` 属性将是一个暂停流。可能无法缓冲大文件的内容。注意:插件可能不支持流媒体内容。
read	boolean function	true	如果为 false，文件将不会被读取，并且它们的 Vinyl 对象将不能通过 `.dest()` 写入磁盘。
since	date timestamp function		设置时，仅为自指定时间以来修改过的文件创建 Vinyl 对象。
removeBOM	boolean function	true	如果为 true，则从 UTF-8 编码的文件中删除 BOM。如果为 false，则忽略 BOM。
sourcemaps	boolean function	false	如果为 true，则在创建的 Vinyl 对象上启用资源映射资源映射支持直接构建到 `src()` 和 `dest()` 中，但是默认情况下是禁用的。使其能够生成内联或外部资源映射。内联资源映射: `const { src, dest } = require('gulp'); const uglify = require('gulp-uglify'); src('input/*/.js', { sourcemaps: true }) .pipe(uglify()) .pipe(dest('output/', { sourcemaps: true }));` 外部资源映射： `const { src, dest } = require('gulp'); const uglify = require('gulp-uglify'); src('input/*/.js', { sourcemaps: true }) .pipe(uglify()) .pipe(dest('output/', { sourcemaps: '.' }));`