Vinyl#

仮想ファイル形式。ファイルがsrc()で読み込まれると、パス、内容、その他のメタデータを含むファイルを表現する Vinyl オブジェクトが生成されます。

Vinyl オブジェクトは、プラグインを使用して変換を適用できます。また、dest()を使用してファイルシステムに保存することもできます。

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/foo.js';

署名#

new Vinyl([options])

パラメータ#

パラメータ	型	注
options	object	詳しくは、以下の「オプション」を参照してください。

戻り値#

単一の仮想ファイルを表す Vinyl クラスのインスタンス。詳しくは、以下の「Vinyl インスタンス」を参照してください。

エラー#

渡されたオプションが、インスタンスプロパティの定義に準拠しない場合（例えば、pathが数値に設定されている場合）、表に定義されているようにエラーがスローされます。

オプション#

名前	型	デフォルト	注
cwd	string	`process.cwd()`	相対パスの基準となるディレクトリ。正規化され、末尾のセパレータが削除されます。
base	string		`relative`インスタンスプロパティを計算するために使用されます。設定されていない場合は、`cwd`の値に戻ります。通常は、グロブベースに設定します。正規化され、末尾のセパレータが削除されます。
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の場合、cloneable-readableストリームでラップされます。

optionsのその他のプロパティは、Vinylインスタンスに直接割り当てられます。

const Vinyl = require('vinyl');

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

Vinylインスタンス#

Vinylオブジェクトの各インスタンスは、仮想ファイルに関する情報にアクセスしたり、変更したりするためのプロパティとメソッドを持ちます。

インスタンスプロパティ#

内部で管理されるすべてのパス（contentsとstatを除くインスタンスプロパティ）は、正規化され、末尾の区切り文字が削除されます。詳しくは正規化と連結をご覧ください。

プロパティ	型	説明	スロー
contents	ReadableStream Buffer `null`	仮想ファイルの内容を取得および設定します。ReadableStreamに設定すると、cloneable-readableストリームでラップされます。	ReadableStream、Buffer、または`null`以外の値に設定した場合。
stat	object	`fs.Stats`のインスタンスを取得および設定します。Vinylオブジェクトがディレクトリまたはシンボリックリンクを表すかどうかを判断する際に使用されます。
cwd	string	現在の作業ディレクトリを取得および設定します。相対パスの導出に使用されます。	空の文字列または文字列以外の値に設定した場合。
base	string	ベースディレクトリを取得および設定します。`relative`インスタンスプロパティの計算に使用されます。`src()`によって生成されたVinylオブジェクトでは、globベースに設定されます。`null`または`undefined`に設定した場合、`cwd`インスタンスプロパティの値に戻ります。	空の文字列または文字列以外の値（`null`または`undefined`を除く）に設定した場合。
path	string	完全な絶対ファイルパスを取得および設定します。現在の`path`とは異なる値を設定すると、新しいパスが`history`インスタンスプロパティに追加されます。	文字列以外の値を設定した場合。
history	array	Vinylオブジェクトに割り当てられたすべての`path`値の配列。最初の要素は元のパス、最後の要素は現在のパスです。このプロパティとその要素は読み取り専用として扱い、`path`インスタンスプロパティを設定して間接的にのみ変更する必要があります。
相対パス	string	`base`と`path`インスタンスプロパティの間の相対パスセグメントを取得します。	任意の値に設定した場合。`path`が利用できないときにアクセスした場合。
dirname	string	`path`インスタンスプロパティのディレクトリを取得および設定します。	`path`が利用できないときにアクセスした場合。
stem	string	`path`インスタンスプロパティのステム（拡張子なしのファイル名）を取得および設定します。	`path`が利用できないときにアクセスした場合。
extname	string	`path`インスタンスプロパティの拡張子を取得および設定します。	`path`が利用できないときにアクセスした場合。
basename	string	`path`インスタンスプロパティのファイル名（`stem + extname`）を取得および設定します。	`path`が利用できないときにアクセスした場合。
symlink	string	シンボリックリンクの参照パスを取得および設定します。	文字列以外の値を設定した場合。

インスタンスメソッド#

メソッド	戻り値の型	戻り値
`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を返す場合にシンボリックと見なされます。これは、Vinylオブジェクトが有効な（または適切にモックされた）`fs.Stats`オブジェクトで構築されたことを前提としています。
`clone([options])`	object	すべてのプロパティが複製された新しいVinylオブジェクト。デフォルトでは、カスタムプロパティはディープクローンされます。`deep`オプションがfalseの場合、カスタム属性はシャロークローンされます。`contents`オプションがfalseで、`contents`インスタンスプロパティがBufferの場合、Bufferはクローンされるのではなく再利用されます。
`inspect()`	string	Vinylオブジェクトのフォーマットされた解釈を返します。Nodeのconsole.logによって自動的に呼び出されます。

正規化と連結#

すべてのパスプロパティは、そのセッターによって正規化されます。path.join()を使用する代わりに、パスを/で連結すると、すべてのプラットフォームで適切に正規化が行われます。\で連結しないでください。これはPOSIXシステムで有効なファイル名文字です。

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

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