hexo-fs


File system module for [Hexo].

Features

- Support for both Promise and callback interface.
- Use [graceful-fs] to avoid EMFILE error and various improvements.
- Use [chokidar] for consistent file watching.

Installation

`` bash
$ npm install hexo-fs --save
`

Usage

` js
const fs = require('hexo-fs');
`

> Some methods in the original fs module are not listed below, but they're available in hexo-fs.

$3

Test whether or not the given path exists by checking with the file system.

$3

Synchronous version of fs.exists.

$3

Creates a directory and its parent directories if they does not exist.

$3

Synchronous version of fs.mkdirs.

$3

Writes data to a file.

Option | Description | Default
--- | --- | ---
encoding | File encoding | utf8
mode | Mode | 438 (0666 in octal)
flag | Flag | w

$3

Synchronous version of fs.writeFile.

$3

Appends data to a file.

Option | Description | Default
--- | --- | ---
encoding | File encoding | utf8
mode | Mode | 438 (0666 in octal)
flag | Flag | w

$3

Synchronous version of fs.appendFile.

$3

Copies a file from src to dest.

$3

Copies a directory from src to dest. It returns an array of copied files.

Option | Description | Default
--- | --- | ---
ignoreHidden | Ignore hidden files | true
ignorePattern | Ignore files which pass the regular expression |

$3

Lists files in a directory.

Option | Description | Default
--- | --- | ---
ignoreHidden | Ignore hidden files | true
ignorePattern | Ignore files which pass the regular expression |

$3

Synchronous version of fs.listDir.

$3

Reads the entire contents of a file.

Option | Description | Default
--- | --- | ---
encoding | File encoding | utf8
flag | Flag | r
escape | Escape UTF BOM and line ending in the content | true

$3

Synchronous version of fs.readFile.

$3

Deletes all files in a directory. It returns an array of deleted files.

Option | Description | Default
--- | --- | ---
ignoreHidden | Ignore hidden files | true
ignorePattern | Ignore files which pass the regular expression |
exclude | Ignore files in the array |

$3

Synchronous version of fs.emptyDir.

$3

Removes a directory and all files in it.

$3

Synchronous version of fs.rmdir.

$3

Watches changes of a file or a directory.

See Chokidar API for more info.

$3

Ensures the given path is available to use or appends a number to the path.

$3

Synchronous version of fs.ensurePath.

$3

Creates the parent directories if they does not exist and returns a writable stream.

$3

Synchronous version of fs.ensureWriteStream`.

License

MIT

[graceful-fs]: https://github.com/isaacs/node-graceful-fs
[Hexo]: https://hexo.io/
[chokidar]: https://github.com/paulmillr/chokidar