to-vfile

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

[vfile][] utility to read and write to the file system.

* What is this?
* When should I use this?
* Install
* Use
* API
* toVFile(description)
* [read(description[, options][, callback])](#readdescription-options-callback)
* [readSync(description[, options])](#readsyncdescription-options)
* [write(description[, options][, callback])](#writedescription-options-callback)
* [writeSync(description[, options])](#writesyncdescription-options)
* BufferEncoding
* Callback
* Compatible
* ReadOptions
* WriteOptions
* Types
* Compatibility
* Contribute
* License

What is this?

This utility puts the file system first.
Where vfile itself focusses on file values (the file contents), this instead
focuses on the file system, which is a common case when working with actual
files from Node.js.

When should I use this?

Use this if you know there’s a file system and want to use it.
Use vfile if there might not be a file system.

Install

This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:

``sh npm install to-vfile`

In Deno with [esm.sh][esmsh]:

`js import {toVFile, read, readSync, write, writeSync} from 'https://esm.sh/to-vfile@8'`

`Use`

`js import {toVFile, read} from 'to-vfile'

console.log(toVFile('readme.md')) console.log(toVFile(new URL('readme.md', import.meta.url))) console.log(await read('.git/HEAD')) console.log(await read('.git/HEAD', 'utf8'))`

Yields:

`js VFile { cwd: '/Users/tilde/Projects/oss/to-vfile', data: {}, history: [ 'readme.md' ], messages: [] } VFile { cwd: '/Users/tilde/Projects/oss/to-vfile', data: {}, history: [ '/Users/tilde/Projects/oss/to-vfile/readme.md' ], messages: [] } VFile { cwd: '/Users/tilde/Projects/oss/to-vfile', data: {}, history: [ '.git/HEAD' ], messages: [], value: } VFile { cwd: '/Users/tilde/Projects/oss/to-vfile', data: {}, history: [ '.git/HEAD' ], messages: [], value: 'ref: refs/heads/main\n' }`

`API`

This package exports the identifiers [read][api-read], [readSync][api-read-sync], [toVFile][api-to-vfile], [write][api-write], and [writeSync][api-write-sync]. There is no default export.

`$3`

Create a virtual file from a description.

This is like VFile, but it accepts a file path instead of file cotnents.

If optionsis a string, URL, or buffer, it’s used as the path. Otherwise, if it’s a file, that’s returned instead. Otherwise, the options are passed through tonew VFile().

###### Parameters

* description ([Compatible][api-compatible], optional) — fath to file, file options, or file itself

###### Returns

Given file or new file ([VFile][vfile]).

`$3`

Create a virtual file and read it in, async.

###### Signatures

* (description[, options], Callback): undefined*(description[, options]): Promise

###### Parameters

* description ([Compatible][api-compatible]) — path to file, file options, or file itself *options ([BufferEncoding][api-buffer-encoding], [ReadOptions][api-read-options], optional) *callback ([Callback][api-callback], optional) — callback called when done

###### Returns

Nothing when a callback is given, otherwise [promise][] that resolves to given file or new file ([VFile][vfile]).

`$3`

Create a virtual file and read it in, synchronously.

###### Parameters

* description ([Compatible][api-compatible]) — path to file, file options, or file itself *options ([BufferEncoding][api-buffer-encoding], [ReadOptions][api-read-options], optional)

###### Returns

Given file or new file ([VFile][vfile]).

`$3`

Create a virtual file and write it, async.

###### Signatures

* (description[, options], Callback): undefined*(description[, options]): Promise

###### Parameters

* description ([Compatible][api-compatible]) — path to file, file options, or file itself *options ([BufferEncoding][api-buffer-encoding], [WriteOptions][api-write-options], optional) *callback ([Callback][api-callback], optional) — callback called when done

###### Returns

Nothing when a callback is given, otherwise [promise][] that resolves to given file or new file ([VFile][vfile]).

`$3`

Create a virtual file and write it, synchronously.

###### Parameters

* description ([Compatible][api-compatible]) — path to file, file options, or file itself *options ([BufferEncoding][api-buffer-encoding], [WriteOptions][api-write-options], optional)

###### Returns

Given file or new file ([VFile][vfile]).

`$3`

Encodings supported by the buffer class (TypeScript type).

This is a copy of the types from Node.

###### Type

`ts type BufferEncoding = | 'ascii' | 'base64' | 'base64url' | 'binary' | 'hex' | 'latin1' | 'ucs-2' | 'ucs2' | 'utf-8' | 'utf16le' | 'utf8'`

`$3`

Callback called after reading or writing a file (TypeScript type).

###### Parameters

* error (Error, optional) — error when reading or writing was not successful *file ([VFile][vfile], optional) — file when reading or writing was successful

###### Returns

Nothing (undefined).

`$3`

URL to file, path to file, options for file, or actual file (TypeScript type).

###### Type

`ts type Compatible = Uint8Array | URL | VFile | VFileOptions | string`

See [VFileOptions][vfile-options] and [VFile][vfile].

`$3`

Configuration for fs.readFile (TypeScript type).

###### Fields

* encoding ([BufferEncoding][api-buffer-encoding], optional) — encoding to read file as, will turnfile.value into a stringif passed *flag (string, optional) — file system flags to use

`$3`

Configuration for fs.writeFile (TypeScript type).

###### Fields

* encoding ([BufferEncoding][api-buffer-encoding], optional) — encoding to write file as whenfile.value is a string*mode (number | string, optional) — file mode (permission and sticky bits) if the file was newly created *flag (string, optional) — file system flags to use

`Types`

This package is fully typed with [TypeScript][]. It exports the additional types [BufferEncoding][api-buffer-encoding], [Callback][api-callback], [Compatible][api-compatible], [ReadOptions][api-read-options], and [WriteOptions][api-write-options].

`Compatibility`

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line,vfile@^8, compatible with Node.js 16.

`Contribute`

See [contributing.md][contributing] in [vfile/.github][health] for ways to get started. See [support.md`][support] for ways to get help.

This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

License

[MIT][license] © [Titus Wormer][author]

[build-badge]: https://github.com/vfile/to-vfile/workflows/main/badge.svg

[build]: https://github.com/vfile/to-vfile/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/vfile/to-vfile.svg

[coverage]: https://codecov.io/github/vfile/to-vfile

[downloads-badge]: https://img.shields.io/npm/dm/to-vfile.svg

[downloads]: https://www.npmjs.com/package/to-vfile

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/vfile/vfile/discussions

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[typescript]: https://www.typescriptlang.org

[contributing]: https://github.com/vfile/.github/blob/main/contributing.md

[support]: https://github.com/vfile/.github/blob/main/support.md

[health]: https://github.com/vfile/.github

[coc]: https://github.com/vfile/.github/blob/main/code-of-conduct.md

[license]: license

[author]: https://wooorm.com

[vfile]: https://github.com/vfile/vfile

[vfile-options]: https://github.com/vfile/vfile#options

[promise]: https://developer.mozilla.org/Web/JavaScript/Reference/Global_Objects/Promise

[api-read]: #readdescription-options-callback

[api-read-sync]: #readsyncdescription-options

[api-to-vfile]: #tovfiledescription

[api-write]: #writedescription-options-callback

[api-write-sync]: #writesyncdescription-options

[api-buffer-encoding]: #bufferencoding

[api-callback]: #callback

[api-compatible]: #compatible

[api-read-options]: #readoptions

[api-write-options]: #writeoptions

to-vfile

[vfile][] utility to read and write to the file system.

What is this?

When should I use this?

Use this if you know there’s a file system and want to use it.
Use vfile if there might not be a file system.

Install

This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:

``sh npm install to-vfile`

In Deno with [esm.sh][esmsh]:

`js import {toVFile, read, readSync, write, writeSync} from 'https://esm.sh/to-vfile@8'`

`Use`

`js import {toVFile, read} from 'to-vfile'

console.log(toVFile('readme.md')) console.log(toVFile(new URL('readme.md', import.meta.url))) console.log(await read('.git/HEAD')) console.log(await read('.git/HEAD', 'utf8'))`

Yields:

`API`

This package exports the identifiers [read][api-read], [readSync][api-read-sync], [toVFile][api-to-vfile], [write][api-write], and [writeSync][api-write-sync]. There is no default export.

`$3`

Create a virtual file from a description.

This is like VFile, but it accepts a file path instead of file cotnents.

If optionsis a string, URL, or buffer, it’s used as the path. Otherwise, if it’s a file, that’s returned instead. Otherwise, the options are passed through tonew VFile().

###### Parameters

* description ([Compatible][api-compatible], optional) — fath to file, file options, or file itself

###### Returns

Given file or new file ([VFile][vfile]).

`$3`

Create a virtual file and read it in, async.

###### Signatures

* (description[, options], Callback): undefined*(description[, options]): Promise

###### Parameters

###### Returns

Nothing when a callback is given, otherwise [promise][] that resolves to given file or new file ([VFile][vfile]).

`$3`

Create a virtual file and read it in, synchronously.

###### Parameters

* description ([Compatible][api-compatible]) — path to file, file options, or file itself *options ([BufferEncoding][api-buffer-encoding], [ReadOptions][api-read-options], optional)

###### Returns

Given file or new file ([VFile][vfile]).

`$3`

Create a virtual file and write it, async.

###### Signatures

* (description[, options], Callback): undefined*(description[, options]): Promise

###### Parameters

###### Returns

Nothing when a callback is given, otherwise [promise][] that resolves to given file or new file ([VFile][vfile]).

`$3`

Create a virtual file and write it, synchronously.

###### Parameters

* description ([Compatible][api-compatible]) — path to file, file options, or file itself *options ([BufferEncoding][api-buffer-encoding], [WriteOptions][api-write-options], optional)

###### Returns

Given file or new file ([VFile][vfile]).

`$3`

Encodings supported by the buffer class (TypeScript type).

This is a copy of the types from Node.

###### Type

`ts type BufferEncoding = | 'ascii' | 'base64' | 'base64url' | 'binary' | 'hex' | 'latin1' | 'ucs-2' | 'ucs2' | 'utf-8' | 'utf16le' | 'utf8'`

`$3`

Callback called after reading or writing a file (TypeScript type).

###### Parameters

* error (Error, optional) — error when reading or writing was not successful *file ([VFile][vfile], optional) — file when reading or writing was successful

###### Returns

Nothing (undefined).

`$3`

URL to file, path to file, options for file, or actual file (TypeScript type).

###### Type

`ts type Compatible = Uint8Array | URL | VFile | VFileOptions | string`

See [VFileOptions][vfile-options] and [VFile][vfile].

`$3`

Configuration for fs.readFile (TypeScript type).

###### Fields

`$3`

Configuration for fs.writeFile (TypeScript type).

###### Fields

`Types`

`Compatibility`

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line,vfile@^8, compatible with Node.js 16.

`Contribute`

See [contributing.md][contributing] in [vfile/.github][health] for ways to get started. See [support.md`][support] for ways to get help.

This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

License

[build-badge]: https://github.com/vfile/to-vfile/workflows/main/badge.svg

[build]: https://github.com/vfile/to-vfile/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/vfile/to-vfile.svg

[coverage]: https://codecov.io/github/vfile/to-vfile

[downloads-badge]: https://img.shields.io/npm/dm/to-vfile.svg

[downloads]: https://www.npmjs.com/package/to-vfile

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/vfile/vfile/discussions

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[typescript]: https://www.typescriptlang.org

[contributing]: https://github.com/vfile/.github/blob/main/contributing.md

[support]: https://github.com/vfile/.github/blob/main/support.md

[health]: https://github.com/vfile/.github

[coc]: https://github.com/vfile/.github/blob/main/code-of-conduct.md

[license]: license

[author]: https://wooorm.com

[vfile]: https://github.com/vfile/vfile

[vfile-options]: https://github.com/vfile/vfile#options

[promise]: https://developer.mozilla.org/Web/JavaScript/Reference/Global_Objects/Promise

[api-read]: #readdescription-options-callback

[api-read-sync]: #readsyncdescription-options

[api-to-vfile]: #tovfiledescription

[api-write]: #writedescription-options-callback

[api-write-sync]: #writesyncdescription-options

[api-buffer-encoding]: #bufferencoding

[api-callback]: #callback

[api-compatible]: #compatible

[api-read-options]: #readoptions

[api-write-options]: #writeoptions

to-vfile

to-vfile

Contents

What is this?

When should I use this?

Install

Use

API

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Types

Compatibility

Contribute

License

to-vfile

to-vfile

Contents

What is this?

When should I use this?

Install

Use

API

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Types

Compatibility

Contribute

License

`Use`

`API`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Types`

`Compatibility`

`Contribute`

`Use`

`API`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Types`

`Compatibility`

`Contribute`