Vinyl

Vinyl介紹

虛擬的文件格式。當(dāng) src() 讀取文件時(shí)，將生成一個(gè) Vinyl 對(duì)象來(lái)表示文件——包括路徑、內(nèi)容和其他元數(shù)據(jù)。

Vinyl 對(duì)象可以使用插件進(jìn)行轉(zhuǎn)換。還可以使用 dest() 將它們持久化到文件系統(tǒng)。

當(dāng)創(chuàng)建您自己的 Vinyl 對(duì)象時(shí)——而不是使用 src() 生成——使用外部 vinyl 模塊，如下面的用法所示。

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

Vinyl函數(shù)原型

new Vinyl([options])

參數(shù)

返回值

返回一個(gè) Vinyl 類(lèi)的實(shí)例，表示一個(gè)單獨(dú)的虛擬文件，詳見(jiàn)下面的 Vinyl 實(shí)例。

可能出現(xiàn)的錯(cuò)誤

當(dāng)傳遞的任何選項(xiàng)都不符合表中定義的實(shí)例屬性定義(如 path 被設(shè)置為一個(gè)數(shù)字)時(shí)拋出錯(cuò)誤。

選項(xiàng)

options 上的任何其他屬性都將直接分配給 Vinyl 實(shí)例。

const Vinyl = require('vinyl');

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

Vinyl 實(shí)例

每個(gè) Vinyl 對(duì)象實(shí)例都具有訪問(wèn)和/或修改虛擬文件信息的屬性和方法。

實(shí)例屬性

所有內(nèi)部管理的路徑——除了 contents 和 stat 之外的任何實(shí)例屬性——都被規(guī)范化，并刪除了末尾分隔符。有關(guān)更多信息，請(qǐng)參見(jiàn)規(guī)范化和連接。

實(shí)例方法

路徑規(guī)范化和連接

所有路徑屬性都由它們的 setter 進(jìn)行規(guī)范化。使用 / 連接路徑，而不是使用 path.join()，這樣就可以在所有平臺(tái)上正確地進(jìn)行規(guī)范化。永遠(yuǎn)不要使用 \ 連接。（ \ 是 POSIX 系統(tǒng)上的一個(gè)有效文件名字符。）

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

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