Vinyl

优质

小牛编辑

141浏览

2023-12-01

虚拟的文件格式。当 src() 读取文件时，将生成一个 Vinyl 对象来表示文件——包括路径、内容和其他元数据。

Vinyl 对象可以使用插件进行转换。还可以使用 dest() 将它们持久化到文件系统。

当创建您自己的 Vinyl 对象时——而不是使用 src() 生成——使用外部 vinyl 模块，如下面的用法所示。

用法

const Vinyl = require('vinyl');

const file = new Vinyl({
  cwd: '/',
  base: '/test/',
  path: '/test/file.js',
  contents: new Buffer('var x = 123')
});

file.relative === 'file.js';

file.dirname === '/test';
file.dirname = '/specs';
file.path === '/specs/file.js';

file.basename === 'file.js';
file.basename = 'file.txt';
file.path === '/specs/file.txt';

file.stem === 'file';
file.stem = 'foo';
file.path === '/specs/foo.txt';
file.extname === '.txt';
file.extname = '.js';
file.path === '/specs/file.js';

函数原型

new Vinyl([options])

参数

参数类型描述

options

object

详情请参加下文返回值

返回一个 Vinyl 类的实例，表示一个单独的虚拟文件，详见下面的可能出现的错误

当传递的任何选项都不符合表中定义的选项

name	type	default	note
cwd	string	`process.cwd()`	将从中推导相对路径的目录。将被规范化，并删除尾随分隔符。
base	string		用于计算 `relative` 实例属性。如果没有设置，则回退到 `cwd` 的值。通常设置为 glob base。将被规范化，并删除尾随分隔符。
path	string		完整的绝对文件路径。将被规范化，并删除尾随分隔符。
history	array	`[ ]`	预先填充 Vinyl 实例的 `history` 的路径数组。通常来自于从以前的 Vinyl 对象派生出一个新的 Vinyl 对象。如果 `path` 和 `history` 都被传递，`path` 将被附加到 `history` 中。每一项都将被规范化，并删除尾随分隔符。
stat	object		一个 `fs.Stats` 实例，通常是对文件调用 `fs.stat()` 的结果。用于确定 Vinyl 对象是否表示目录或符号链接。
contents	ReadableStream Buffer `null`	`null`	文件的内容。如果 `contents` 是一个 ReadableStream，它将被包装在一个可克隆可读的流中。

options 上的任何其他属性都将直接分配给 Vinyl 实例。

const Vinyl = require('vinyl');

const file = new Vinyl({ foo: 'bar' });
file.foo === 'bar';

Vinyl 实例

每个 Vinyl 对象实例都具有访问和/或修改虚拟文件信息的属性和方法。

实例属性

所有内部管理的路径——除了 contents 和 stat 之外的任何实例属性——都被规范化，并删除了末尾分隔符。有关更多信息，请参见实例方法

方法	返回值类型	返回值
`isBuffer()`	boolean	如果 `contents` 实例属性是一个 Buffer，则返回 true。
`isStream()`	boolean	如果 `contents` 实例属性是一个 Stream，则返回 true。
`isNull()`	boolean	如果 `contents` 实例属性为 `null`，则返回 true。
`isDirectory()`	boolean	如果实例表示一个目录，则返回 true。当 `isNull()` 返回 true，`stat` 实例属性是一个对象，并且 `stat.isDirectory()` 返回 true 时，实例被认为是一个目录。这假设 Vinyl 对象是用一个有效的（或适当模拟的） `fs.Stats` 对象构造的。
`isSymbolic()`	boolean	如果实例表示符号链接，则返回 true。当 `isNull()` 返回 true，`stat` 实例属性是一个对象，并且 `stat.isSymbolicLink()` 返回 true 时，实例被认为是 symbolic。这假设 Vinyl 对象是用一个有效的（或适当模拟的） `fs.Stats` 对象构造的。
`clone([options])`	object	A new Vinyl object with all properties cloned. 一个使用所有属性克隆出的新的 Vinyl 对象。默认情况下，自定义属性是深拷贝。如果 `deep` 选项为 false，自定义属性将被浅拷贝。如果 `contents` 选项设置为 fasle 并且 `contents` 属性是一个 Buffer，那么这个 Buffer 将被复用，而不是克隆。
`inspect()`	string	返回 Vinyl 对象的格式化说明。由 Node 的 console.log 自动调用。

路径规范化和连接

所有路径属性都由它们的 setter 进行规范化。使用 / 连接路径，而不是使用 path.join()，这样就可以在所有平台上正确地进行规范化。永远不要使用 \ 连接。（ \ 是 POSIX 系统上的一个有效文件名字符。）

const file = new File();
file.path = '/' + 'test' + '/' + 'foo.bar';

console.log(file.path);
// posix => /test/foo.bar
// win32 => \\test\\foo.bar