Add separate exports of functions

Author: wooorm

lib/index.js

@@ -43,17 +43,14 @@ export function toVFile(options) {
   return looksLikeAVFile(options) ? options : new VFile(options)
 }
 
-toVFile.readSync = readSync
-toVFile.writeSync = writeSync
-
 /**
  * Create a virtual file and read it in, synchronously.
  *
  * @param {Compatible} description
  * @param {ReadOptions} [options]
  * @returns {VFile}
  */
-function readSync(description, options) {
+export function readSync(description, options) {
   var file = toVFile(description)
   file.value = fs.readFileSync(path.resolve(file.cwd, file.path), options)
   return file
@@ -66,13 +63,13 @@ function readSync(description, options) {
  * @param {WriteOptions} [options]
  * @returns {VFile}
  */
-function writeSync(description, options) {
+export function writeSync(description, options) {
   var file = toVFile(description)
   fs.writeFileSync(path.resolve(file.cwd, file.path), file.value || '', options)
   return file
 }
 
-toVFile.read =
+export const read =
   /**
    * @type {{
    *   (description: Compatible, options: ReadOptions, callback: Callback): void
@@ -141,7 +138,7 @@ toVFile.read =
     }
   )
 
-toVFile.write =
+export const write =
   /**
    * @type {{
    *   (description: Compatible, options: WriteOptions, callback: Callback): void
@@ -221,3 +218,8 @@ function looksLikeAVFile(value) {
     'messages' in value
   )
 }
+
+toVFile.readSync = readSync
+toVFile.writeSync = writeSync
+toVFile.read = read
+toVFile.write = write

readme.md

@@ -25,12 +25,12 @@ npm install to-vfile
 ## Use
 
 ```js
-import {toVFile} from 'to-vfile'
+import {toVFile, readSync} from 'to-vfile'
 
 console.log(toVFile('readme.md'))
 console.log(toVFile(new URL('./readme.md', import.meta.url)))
-console.log(toVFile.readSync('.git/HEAD'))
-console.log(toVFile.readSync('.git/HEAD', 'utf8'))
+console.log(readSync('.git/HEAD'))
+console.log(readSync('.git/HEAD', 'utf8'))
 ```
 
 Yields:
@@ -66,7 +66,8 @@ VFile {
 
 ## API
 
-This package exports the following identifiers: `toVFile`.
+This package exports the following identifiers: `toVFile`, `read`, `readSync`,
+`write`, and `writeSync`.
 There is no default export.
 
 ### `toVFile(options)`
@@ -77,7 +78,7 @@ Works like the [vfile][] constructor, except when `options` is `string` or
 `{value: options}`, or when `options` is a WHATWG `URL` object, in which case
 it’s treated as `{path: fileURLToPath(options)}`.
 
-### `toVFile.read(options[, encoding][, callback])`
+### `read(options[, encoding][, callback])`
 
 Creates a virtual file from options (`toVFile(options)`), reads the file from
 the file system and populates `file.value` with the result.
@@ -87,12 +88,12 @@ file.
 If `callback` is not given, returns a [`Promise`][promise] that is rejected with
 an error or resolved with the populated virtual file.
 
-### `toVFile.readSync(options[, encoding])`
+### `readSync(options[, encoding])`
 
-Like `toVFile.read` but synchronous.
+Like `read` but synchronous.
 Either throws an error or returns a populated virtual file.
 
-### `toVFile.write(options[, fsOptions][, callback])`
+### `write(options[, fsOptions][, callback])`
 
 Creates a virtual file from `options` (`toVFile(options)`), writes the file to
 the file system.
@@ -101,9 +102,9 @@ If `callback` is given, invokes it with an error, if any.
 If `callback` is not given, returns a [`Promise`][promise] that is rejected with
 an error or resolved with the written virtual file.
 
-### `toVFile.writeSync(options[, fsOptions])`
+### `writeSync(options[, fsOptions])`
 
-Like `toVFile.write` but synchronous.
+Like `write` but synchronous.
 Either throws an error or returns a populated virtual file.
 
 ## Contribute