npm 包 windows-fs 使用教程

介绍

windows-fs 是一个可以在 Node.js 环境中操作与 Windows 文件系统（包括网络共享）交互的 npm 包。该包可以帮助前端工程师轻松地在 Node.js 中读取、写入以及操作 Windows 系统文件。

安装

安装 windows-fs 只需要使用 npm 就可以了：

npm install windows-fs

使用

首先需要引入 windows-fs 包：

const windowsFs = require('windows-fs');

接着，我们可以操作 Windows 中的一个文件夹：

const folderPath = "\\\\192.168.1.1\\SharedFolder";
const folderItems = await windowsFs.readdir(folderPath);

上面的示例代码展示了如何读取共享文件夹 \\192.168.1.1\SharedFolder 中的所有文件和文件夹。其中 readdir() 方法将返回文件夹中的所有项目，结果保存在 folderItems 变量中。

下面是常用的 windows-fs 方法，以及其用法：

读取文件夹

const folderPath = "C:\\Windows";
const folderItems = await windowsFs.readdir(folderPath);

创建文件夹

const folderPath = "C:\\MyFolder";
await windowsFs.mkdir(folderPath);

读取文件

const filePath = "C:\\MyFile.txt";
const fileContent = await windowsFs.readFile(filePath, "utf8");

写入文件

const filePath = "C:\\MyFile.txt";
const fileContent = "Hello World!";
await windowsFs.writeFile(filePath, fileContent, "utf8");

拷贝文件

const sourceFile = "C:\\MyFile.txt";
const destinationFile = "C:\\Backup\\MyFile.txt";
await windowsFs.copyFile(sourceFile, destinationFile);

深度和学习

在 Node.js 这个平台上，fs 模块已经为我们提供了一批常用的文件操作 API，但是它有一个缺陷，它不能够像 Windows 功能强大。比如处理 UNC（Universal Naming Convention）路径，即网络共享文件夹路径。如果我们要在 Node.js 中操作这类目录，该怎么办呢？

这时候，windows-fs 就派上用场了。使用它，你可以很快上手，读取文件以及文件夹，操作 Windows 系统文件就跟操作本地文件一样。

指导意义

使用 windows-fs 包可以帮助前端工程师轻松地在 Node.js 中读取、写入以及操作 Windows 系统文件。这个包在实际工作中可以用来备份重要文件、将工作文档同步到云端、上传数据到共享目录等。使用该包可以让你更快地完成这些重要的任务，提高工作效率。

示例代码

读取 Windows 系统文件夹的示例代码：

-- -------------------- ---- -------
----- --------- - ----------------------

----- -------- ------------ -
  --- -
    -- -- ------- -----
    ----- ---------- - --------------------------------
    -- -----------
    ----- ----------- - ----- ------------------------------
    -------------------------------------
    ------------------------
    -------------------------
  - ----- ----- -
    -----------------
  -
-

-------------

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671128dd3466f61ffe47b