vinyl-file
Create a vinyl file from an actual file
Last updated 4 years ago by sindresorhus .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install vinyl-file 
SYNC missed versions from official npm registry.

vinyl-file Build Status

Create a Vinyl file from an actual file

Install

$ npm install --save vinyl-file

Usage

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'

API

read(path, [options])

Returns a promise for a Vinyl file.

readSync(path, [options])

Create a Vinyl file synchronously and return it.

options

Type: Object

base

Type: string
Default: process.cwd()

Override the base of the Vinyl file.

cwd

Type: string
Default: process.cwd()

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

buffer

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.

read

Type: boolean
Default: true

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

Related

  • vinyl-read - Create vinyl files from glob patterns

License

MIT © Sindre Sorhus

Current Tags

  • 3.0.0                                ...           latest (4 years ago)

8 Versions

  • 3.0.0                                ...           4 years ago
  • 2.0.0                                ...           5 years ago
  • 1.3.0                                ...           5 years ago
  • 1.2.1                                ...           5 years ago
  • 1.2.0                                ...           5 years ago
  • 1.1.1                                ...           6 years ago
  • 1.1.0                                ...           6 years ago
  • 1.0.0                                ...           6 years ago
Maintainers (1)
Downloads
Today 2,779
This Week 10,005
This Month 43,006
Last Day 3,654
Last Week 20,077
Last Month 85,177
Dependencies (5)
Dev Dependencies (3)
Dependents (192)

Copyright 2014 - 2016 © taobao.org |