{"maintainers":[{"name":"sindresorhus","email":"sindresorhus@gmail.com"}],"keywords":["vinyl","fs","file","read","virtual","format","gulp","gulpfriendly"],"dist-tags":{"latest":"3.0.0"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"description":"Create a vinyl file from an actual file","readme":"# vinyl-file [](https://travis-ci.org/sindresorhus/vinyl-file)\n\n> Create a [Vinyl file](https://github.com/gulpjs/vinyl) from an actual file\n\n\n## Install\n\n```\n$ npm install --save vinyl-file\n```\n\n\n## Usage\n\n```js\nconst vinylFile = require('vinyl-file');\n\nvinylFile.read('index.js').then(file => {\n\tconsole.log(file.path);\n\t//=> '/Users/sindresorhus/dev/vinyl-file/index.js'\n\n\tconsole.log(file.cwd);\n\t//=> '/Users/sindresorhus/dev/vinyl-file'\n});\n\nconst file = vinylFile.readSync('index.js');\n\nconsole.log(file.path);\n//=> '/Users/sindresorhus/dev/vinyl-file/index.js'\n\nconsole.log(file.cwd);\n//=> '/Users/sindresorhus/dev/vinyl-file'\n```\n\n\n## API\n\n### read(path, [options])\n\nReturns a promise for a Vinyl file.\n\n### readSync(path, [options])\n\nCreate a Vinyl file synchronously and return it.\n\n#### options\n\nType: `Object`\n\n##### base\n\nType: `string`
\nDefault: `process.cwd()`\n\nOverride the `base` of the Vinyl file.\n\n##### cwd\n\nType: `string`
\nDefault: `process.cwd()`\n\nOverride the `cwd` (current working directory) of the Vinyl file.\n\n##### buffer\n\nType: `boolean`
\nDefault: `true`\n\nSetting 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.\n\n##### read\n\nType: `boolean`
\nDefault: `true`\n\nSetting this to `false` will return `file.contents` as `null` and not read the file at all.\n\n\n## Related\n\n- [vinyl-read](https://github.com/SamVerschueren/vinyl-read) - Create vinyl files from glob patterns\n\n\n## License\n\nMIT © [Sindre Sorhus](https://sindresorhus.com)\n","repository":{"type":"git","url":"git+https://github.com/sindresorhus/vinyl-file.git"},"users":{"n370":true,"landy2014":true},"bugs":{"url":"https://github.com/sindresorhus/vinyl-file/issues"},"license":"MIT","versions":{"1.0.0":{"name":"vinyl-file","version":"1.0.0","description":"Create a vinyl file from an actual file","license":"MIT","repository":{"type":"git","url":"https://github.com/sindresorhus/vinyl-file"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"http://sindresorhus.com"},"engines":{"node":">=0.10.0"},"scripts":{"test":"node test.js"},"files":["index.js"],"keywords":["vinyl","fs","file","read","virtual","format"],"dependencies":{"graceful-fs":"^3.0.2","strip-bom":"^1.0.0","vinyl":"^0.4.3"},"devDependencies":{"ava":"0.0.4"},"gitHead":"5586c706c46dbef225b9071c872f34b110abd152","bugs":{"url":"https://github.com/sindresorhus/vinyl-file/issues"},"homepage":"https://github.com/sindresorhus/vinyl-file","_id":"vinyl-file@1.0.0","_shasum":"0387f563cdd6be5b9719f21f5de276de5ffdc083","_from":".","_npmVersion":"1.4.23","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"maintainers":[{"name":"sindresorhus","email":"sindresorhus@gmail.com"}],"dist":{"shasum":"0387f563cdd6be5b9719f21f5de276de5ffdc083","tarball":"http://nexus.dui88.com:8081/nexus/content/groups/npm-all/vinyl-file/-/vinyl-file-1.0.0.tgz"},"directories":{}},"1.1.0":{"name":"vinyl-file","version":"1.1.0","description":"Create a vinyl file from an actual file","license":"MIT","repository":{"type":"git","url":"https://github.com/sindresorhus/vinyl-file"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"http://sindresorhus.com"},"engines":{"node":">=0.10.0"},"scripts":{"test":"node test.js"},"files":["index.js"],"keywords":["vinyl","fs","file","read","virtual","format","gulp","gulpfriendly"],"dependencies":{"graceful-fs":"^3.0.2","strip-bom":"^1.0.0","vinyl":"^0.4.3"},"devDependencies":{"ava":"0.0.4","isstream":"^0.1.0"},"gitHead":"76b8bda6bd4e67f4cf178ae6df2c427cb2bba39f","bugs":{"url":"https://github.com/sindresorhus/vinyl-file/issues"},"homepage":"https://github.com/sindresorhus/vinyl-file","_id":"vinyl-file@1.1.0","_shasum":"5fadd9b4f295d686af265a947b7e1c1386d0ef81","_from":".","_npmVersion":"1.4.23","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"maintainers":[{"name":"sindresorhus","email":"sindresorhus@gmail.com"}],"dist":{"shasum":"5fadd9b4f295d686af265a947b7e1c1386d0ef81","tarball":"http://nexus.dui88.com:8081/nexus/content/groups/npm-all/vinyl-file/-/vinyl-file-1.1.0.tgz"},"directories":{}},"1.1.1":{"name":"vinyl-file","version":"1.1.1","description":"Create a vinyl file from an actual file","license":"MIT","repository":{"type":"git","url":"https://github.com/sindresorhus/vinyl-file"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"http://sindresorhus.com"},"engines":{"node":">=0.10.0"},"scripts":{"test":"node test.js"},"files":["index.js"],"keywords":["vinyl","fs","file","read","virtual","format","gulp","gulpfriendly"],"dependencies":{"graceful-fs":"^3.0.2","strip-bom":"^1.0.0","vinyl":"^0.4.3"},"devDependencies":{"ava":"0.0.4","isstream":"^0.1.0"},"gitHead":"7f212093521084d585aa8214534a8cf39aa8ed95","bugs":{"url":"https://github.com/sindresorhus/vinyl-file/issues"},"homepage":"https://github.com/sindresorhus/vinyl-file","_id":"vinyl-file@1.1.1","_shasum":"81b655f26e658bd2e8829f28d63f847d6843d6d0","_from":".","_npmVersion":"2.1.16","_nodeVersion":"0.10.32","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"maintainers":[{"name":"sindresorhus","email":"sindresorhus@gmail.com"}],"dist":{"shasum":"81b655f26e658bd2e8829f28d63f847d6843d6d0","tarball":"http://nexus.dui88.com:8081/nexus/content/groups/npm-all/vinyl-file/-/vinyl-file-1.1.1.tgz"},"directories":{}},"1.2.0":{"name":"vinyl-file","version":"1.2.0","description":"Create a vinyl file from an actual file","license":"MIT","repository":{"type":"git","url":"https://github.com/sindresorhus/vinyl-file"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"http://sindresorhus.com"},"engines":{"node":">=0.10.0"},"scripts":{"test":"node test.js"},"files":["index.js"],"keywords":["vinyl","fs","file","read","virtual","format","gulp","gulpfriendly"],"dependencies":{"graceful-fs":"^3.0.2","strip-bom":"^1.0.0","vinyl":"^0.5.0"},"devDependencies":{"ava":"0.0.4","is-stream":"^1.0.0"},"gitHead":"41fc11b95881035c9411730f3a68051980e7cb25","bugs":{"url":"https://github.com/sindresorhus/vinyl-file/issues"},"homepage":"https://github.com/sindresorhus/vinyl-file","_id":"vinyl-file@1.2.0","_shasum":"4b7ddf484419820a4f6cf276949108c7c98c9497","_from":".","_npmVersion":"2.11.2","_nodeVersion":"0.12.5","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"4b7ddf484419820a4f6cf276949108c7c98c9497","tarball":"http://nexus.dui88.com:8081/nexus/content/groups/npm-all/vinyl-file/-/vinyl-file-1.2.0.tgz"},"maintainers":[{"name":"sindresorhus","email":"sindresorhus@gmail.com"}],"directories":{}},"1.2.1":{"name":"vinyl-file","version":"1.2.1","description":"Create a vinyl file from an actual file","license":"MIT","repository":{"type":"git","url":"https://github.com/sindresorhus/vinyl-file"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"http://sindresorhus.com"},"engines":{"node":">=0.10.0"},"scripts":{"test":"node test.js"},"files":["index.js"],"keywords":["vinyl","fs","file","read","virtual","format","gulp","gulpfriendly"],"dependencies":{"graceful-fs":"^4.1.2","strip-bom":"^2.0.0","strip-bom-stream":"^1.0.0","vinyl":"^0.5.0"},"devDependencies":{"ava":"0.0.4","is-stream":"^1.0.0"},"gitHead":"32fb585ff3eff6396fa9ccfe70db30c64a0819c6","bugs":{"url":"https://github.com/sindresorhus/vinyl-file/issues"},"homepage":"https://github.com/sindresorhus/vinyl-file","_id":"vinyl-file@1.2.1","_shasum":"f439e35aba68b6e6508290f67fe34e9656eadd6f","_from":".","_npmVersion":"2.11.2","_nodeVersion":"0.12.5","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"f439e35aba68b6e6508290f67fe34e9656eadd6f","tarball":"http://nexus.dui88.com:8081/nexus/content/groups/npm-all/vinyl-file/-/vinyl-file-1.2.1.tgz"},"maintainers":[{"name":"sindresorhus","email":"sindresorhus@gmail.com"}],"directories":{}},"1.3.0":{"name":"vinyl-file","version":"1.3.0","description":"Create a vinyl file from an actual file","license":"MIT","repository":{"type":"git","url":"https://github.com/sindresorhus/vinyl-file"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=0.10.0"},"scripts":{"test":"xo && node test.js"},"files":["index.js"],"keywords":["vinyl","fs","file","read","virtual","format","gulp","gulpfriendly"],"dependencies":{"graceful-fs":"^4.1.2","strip-bom":"^2.0.0","strip-bom-stream":"^1.0.0","vinyl":"^1.1.0"},"devDependencies":{"ava":"0.0.4","is-stream":"^1.0.0","xo":"*"},"gitHead":"9bdbc6d9211d7d896e2e3c88afa8beb530d873b7","bugs":{"url":"https://github.com/sindresorhus/vinyl-file/issues"},"homepage":"https://github.com/sindresorhus/vinyl-file","_id":"vinyl-file@1.3.0","_shasum":"aa05634d3a867ba91447bedbb34afcb26f44f6e7","_from":".","_npmVersion":"2.14.7","_nodeVersion":"4.2.1","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"aa05634d3a867ba91447bedbb34afcb26f44f6e7","tarball":"http://nexus.dui88.com:8081/nexus/content/groups/npm-all/vinyl-file/-/vinyl-file-1.3.0.tgz"},"maintainers":[{"name":"sindresorhus","email":"sindresorhus@gmail.com"}],"directories":{}},"2.0.0":{"name":"vinyl-file","version":"2.0.0","description":"Create a vinyl file from an actual file","license":"MIT","repository":{"type":"git","url":"https://github.com/sindresorhus/vinyl-file"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=0.10.0"},"scripts":{"test":"xo && ava"},"files":["index.js"],"keywords":["vinyl","fs","file","read","virtual","format","gulp","gulpfriendly"],"dependencies":{"graceful-fs":"^4.1.2","pify":"^2.3.0","pinkie-promise":"^2.0.0","strip-bom":"^2.0.0","strip-bom-stream":"^2.0.0","vinyl":"^1.1.0"},"devDependencies":{"ava":"*","is-stream":"^1.0.0","xo":"*"},"gitHead":"71b83a78f0d7f58b7f6829a45dc0c22faa8d44c8","bugs":{"url":"https://github.com/sindresorhus/vinyl-file/issues"},"homepage":"https://github.com/sindresorhus/vinyl-file","_id":"vinyl-file@2.0.0","_shasum":"a7ebf5ffbefda1b7d18d140fcb07b223efb6751a","_from":".","_npmVersion":"2.14.12","_nodeVersion":"4.2.4","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"a7ebf5ffbefda1b7d18d140fcb07b223efb6751a","tarball":"http://nexus.dui88.com:8081/nexus/content/groups/npm-all/vinyl-file/-/vinyl-file-2.0.0.tgz"},"maintainers":[{"name":"sindresorhus","email":"sindresorhus@gmail.com"}],"directories":{}},"3.0.0":{"name":"vinyl-file","version":"3.0.0","description":"Create a vinyl file from an actual file","license":"MIT","repository":{"type":"git","url":"git+https://github.com/sindresorhus/vinyl-file.git"},"author":{"name":"Sindre Sorhus","email":"sindresorhus@gmail.com","url":"sindresorhus.com"},"engines":{"node":">=4"},"scripts":{"test":"xo && ava"},"files":["index.js"],"keywords":["vinyl","fs","file","read","virtual","format","gulp","gulpfriendly"],"dependencies":{"graceful-fs":"^4.1.2","pify":"^2.3.0","strip-bom-buf":"^1.0.0","strip-bom-stream":"^2.0.0","vinyl":"^2.0.1"},"devDependencies":{"ava":"*","is-stream":"^1.0.0","xo":"*"},"gitHead":"16a3203822d34a54b8d4d245dea148f69b0de2a5","bugs":{"url":"https://github.com/sindresorhus/vinyl-file/issues"},"homepage":"https://github.com/sindresorhus/vinyl-file#readme","_id":"vinyl-file@3.0.0","_shasum":"b104d9e4409ffa325faadd520642d0a3b488b365","_from":".","_npmVersion":"2.15.11","_nodeVersion":"4.6.2","_npmUser":{"name":"sindresorhus","email":"sindresorhus@gmail.com"},"dist":{"shasum":"b104d9e4409ffa325faadd520642d0a3b488b365","tarball":"http://nexus.dui88.com:8081/nexus/content/groups/npm-all/vinyl-file/-/vinyl-file-3.0.0.tgz"},"maintainers":[{"name":"sindresorhus","email":"sindresorhus@gmail.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/vinyl-file-3.0.0.tgz_1484314552830_0.22277253423817456"},"directories":{}}},"name":"vinyl-file","time":{"modified":"2017-01-13T13:35:53.066Z","created":"2014-09-10T19:38:23.183Z","1.0.0":"2014-09-10T19:38:23.183Z","1.1.0":"2014-09-11T17:48:01.055Z","1.1.1":"2015-01-12T08:10:37.227Z","1.2.0":"2015-06-27T10:01:27.164Z","1.2.1":"2015-06-30T12:04:27.279Z","1.3.0":"2015-11-14T11:38:49.357Z","2.0.0":"2015-12-31T10:52:16.371Z","3.0.0":"2017-01-13T13:35:53.066Z"},"readmeFilename":"readme.md","homepage":"https://github.com/sindresorhus/vinyl-file#readme"}