to-vfile
    Overview
    Documentation
    Tutorials
    Insights
    Code
    Dependencies
    Contributors
    Jobs

to-vfile

Create a vfile from a file-path

6.0.0  •  Updated 10 months ago  •  by vfile  •  MIT License

Build Coverage Downloads Sponsors Backers Chat

Create a vfile from a file-path. Optionally populates them from the file-system as well. Can write virtual files to file-system too.

Install

npm:

npm install to-vfile

Note: the file-system stuff is not available in the browser.

Usage

var vfile = require('to-vfile')

console.log(vfile('readme.md'))
console.log(vfile.readSync('.git/HEAD'))
console.log(vfile.readSync('.git/HEAD', 'utf8'))

Yields:

VFile {
  data: {},
  messages: [],
  history: [ 'readme.md' ],
  cwd: '/Users/tilde/projects/oss/to-vfile' }
VFile {
  data: {},
  messages: [],
  history: [ '.git/HEAD' ],
  cwd: '/Users/tilde/projects/oss/to-vfile',
  contents: <Buffer 72 65 66 3a 20 72 65 66 73 2f 68 65 61 64 73 2f 6d 61 73 74 65 72 0a> }
VFile {
  data: {},
  messages: [],
  history: [ '.git/HEAD' ],
  cwd: '/Users/tilde/projects/oss/to-vfile',
  contents: 'ref: refs/heads/master\n' }

API

toVFile(options)

Create a virtual file. Works like the vfile constructor, except when options is string or Buffer, in which case it’s treated as {path: options} instead of {contents: options}.

toVFile.read(options[, encoding][, callback])

Creates a virtual file from options (toVFile(options)), reads the file from the file-system and populates file.contents with the result. If encoding is specified, it’s passed to fs.readFile. If callback is given, invokes it with either an error or the populated virtual file. If callback is not given, returns a Promise that is rejected with an error or resolved with the populated virtual file.

toVFile.readSync(options[, encoding])

Like toVFile.read but synchronous. Either throws an error or returns a populated virtual file.

toVFile.write(options[, fsOptions][, callback])

Creates a virtual file from options (toVFile(options)), writes the file to the file-system. fsOptions are passed to fs.writeFile. If callback is given, invokes it with an error, if any. If callback is not given, returns a Promise that is rejected with an error or resolved without any value.

toVFile.writeSync(options[, fsOptions])

Like toVFile.write but synchronous. Throws an error, if any.

Contribute

See contributing.md in vfile/.github for ways to get started. See support.md for ways to get help.

This project has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer

Popularity

Weekly Downloads
84.6K
Stars
25

Maintenance

Development

Last ver 10 months ago
Created 5 years ago
Last commit 10 months ago
21 days between commits

Technology

Node version: 12.2.0
9.9K unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

5 contributors
Titus Wormer
Maintainer, 65 commits, 2 merges, 1 PRs
Greenkeeper
1 commits, 3 PRs
Works at greenkeeperio
Alexander Kachkaev
1 commits, 1 PRs
Dan Burzo
1 commits, 1 PRs
Works at Evercoder
Christian Murphy
Maintainer
Works at Unicon, Inc.
John Otander
Maintainer
Works at gatsbyjs

Tags

virtual
file
text
processing
file-path
file
path
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
FacebookTwitterLinkedIn
© 2020 Devstore, Inc.