| Server IP : 185.86.78.101 / Your IP : 216.73.216.124 Web Server : Apache System : Linux 675867-vds-valikoshka1996.gmhost.pp.ua 5.4.0-150-generic #167-Ubuntu SMP Mon May 15 17:35:05 UTC 2023 x86_64 User : www ( 1000) PHP Version : 7.4.33 Disable Function : passthru,exec,system,putenv,chroot,chgrp,chown,shell_exec,popen,proc_open,pcntl_exec,ini_alter,ini_restore,dl,openlog,syslog,readlink,symlink,popepassthru,pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,imap_open,apache_setenv MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /www/wwwroot/mifepriston.org/node_modules/vinyl-file/ |
Upload File : |
# vinyl-file [](https://travis-ci.org/sindresorhus/vinyl-file)
> Create a [vinyl file](https://github.com/wearefractal/vinyl) from an actual file
## Install
```
$ npm install --save vinyl-file
```
## Usage
```js
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
##### 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.
## License
MIT © [Sindre Sorhus](http://sindresorhus.com)