在前端开发中，操作本地文件系统是常见且必要的操作，例如读取本地文件、写入本地文件、创建文件夹等等。而 promise-filesystem 是一个基于 Promise 的 npm 包，它提供了简单易用又高效的 API 来操作本地文件系统。
安装
安装 promise-filesystem 很简单，只需要在终端输入以下命令即可：
npm install promise-filesystem
安装完成后，你可以在你项目的代码中使用它。
使用
让我们来看一些 promise-filesystem 的使用示例。
读取文件内容
来看一个读取文件内容并输出的简单示例：
const { readFile } = require('promise-filesystem');
const path = require('path');
const exampleFilePath = path.join(__dirname, 'example.txt');
readFile(exampleFilePath, 'utf8')
.then(content => console.log(content))
.catch(err => console.log('Error reading file', err));假设当前目录下存在一个 example.txt 文件。上述代码将会在终端输出 example.txt 文件的内容。
写入文件
下面这个示例演示了如何将一些内容写入到一个文件中：
-- -------------------- ---- ------- ----- - --------- - - ------------------------------ ----- ---- - ---------------- ----- --------------- - -------------------- --------------- ----- -------------- - ----- -- ---- ------- -- ------- -------------------------- --------------- -------- -- ----------------- ------- --------------- ---------- -- ------------------ ------- ------ ------
运行以上代码，会将字符串 "This is some content to write" 写入到 example.txt 文件中。
创建目录
你可以使用 ensureDir 来创建一个目录：
const { ensureDir } = require('promise-filesystem');
const path = require('path');
const exampleDir = path.join(__dirname, 'example');
ensureDir(exampleDir)
.then(() => console.log('Directory created successfully'))
.catch(err => console.log('Error creating directory', err));代码将按照指定的路径，在当前目录下创建一个名为 example 的文件夹。
API
以下是 promise-filesystem 目前支持的方法：
readFile(filePath: string, encoding: string | null): Promise<string>- 读取指定路径的文件，并以字符串形式返回文件内容。writeFile(filePath: string, data: string | Buffer, options?: WriteFileOptions): Promise<void>- 将数据写入指定的文件。该方法的第三个参数是可选的，包含一些可配置的选项。ensureDir(directoryPath: string): Promise<void>- 创建一个目录，如果目录已经存在，则不会重新创建它。stat(path: string): Promise<Stats>- 获取一个文件或目录的详细信息，例如创建时间、修改时间等等。readdir(directoryPath: string): Promise<string[]>- 读取指定目录下的文件列表，并以字符串数组形式返回。
结语
promise-filesystem 提供了方便实用的 API，能够让开发者轻而易举地操作本地文件系统。希望这篇教程能够对你的开发工作有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055b8981e8991b448d9289