Create a Vinyl file from an actual file

$ npm install --save vinyl-file

const vinylFile = require('vinyl-file');

vinylFile.read('index.js').then(file => {
	console.log(file.path);
	//=> '/Users/sindresorhus/dev/vinyl-file/index.js'

	console.log(file.cwd);
	//=> '/Users/sindresorhus/dev/vinyl-file'
});

const file = vinylFile.readSync('index.js');

console.log(file.path);
//=> '/Users/sindresorhus/dev/vinyl-file/index.js'

console.log(file.cwd);
//=> '/Users/sindresorhus/dev/vinyl-file'

Returns a promise for a Vinyl file.

Create a Vinyl file synchronously and return it.

Type: Object

Type: string
Default: process.cwd()

Override the base of the Vinyl file.

Type: string
Default: process.cwd()

Override the cwd (current working directory) of the Vinyl file.

Type: boolean
Default: true

Setting this to false will return file.contents as a stream. This is useful when working with large files. Note: Plugins might not implement support for streams.

Type: boolean
Default: true

Setting this to false will return file.contents as null and not read the file at all.

• vinyl-read - Create vinyl files from glob patterns

MIT © Sindre Sorhus