alinex-fs 是一个 Node.js 模块，支持文件和文件夹操作，是一个很好用的工具。它封装了 Node.js 内置模块 fs，提供了更加丰富、易用的 API。alinex-fs 提供的 API 包括：文件读写、目录创建、目录遍历、复制和删除等。
安装
使用 npm 安装 alinex-fs：
npm install alinex-fs
API
alinex-fs 提供了丰富的 API：
- read
- readJson
- readIgnore
- readUtf8
- write
- writeJson
- writeUtf8
- appendUtf8
- mkdir
- copy
- remove
- removeRecursive
- move
- symlink
下面我们就一一介绍这些 API。
read
fs.read(filepath)
读取文件内容。
const fs = require('alinex-fs');
// 读取文件
fs.read('./file.txt').then(content => {
console.log(content);
}).catch(err => {
console.error(err);
});返回值：Promise，文件内容。
fs.readJson(filepath)
读取 JSON 格式的文件内容。
const fs = require('alinex-fs');
// 读取 json 文件
fs.readJson('./config.json').then(data => {
console.log(data);
}).catch(err => {
console.error(err);
});返回值：Promise，JSON 对象。
fs.readIgnore(filepath, ignoreList)
读取文件内容，并根据 ignoreList 进行忽略。
const fs = require('alinex-fs');
// 读取文件并忽略注释行
fs.readIgnore('./config.txt', /^#/gm).then(content => {
console.log(content);
}).catch(err => {
console.error(err);
});返回值：Promise，处理过后的文件内容。
fs.readUtf8(filepath)
读取文件内容，并返回 UTF-8 字符编码。
const fs = require('alinex-fs');
// 读取文件并返回 UTF-8 编码
fs.readUtf8('./file.txt').then(content => {
console.log(content);
}).catch(err => {
console.error(err);
});返回值：Promise，文件内容。
write
fs.write(filepath, content)
往文件写入内容。
const fs = require('alinex-fs');
// 写入文件
fs.write('./file.txt', 'Hello World!').then(() => {
console.log('文件写入成功!');
}).catch(err => {
console.error(err);
});返回值：Promise，无返回值。
fs.writeJson(filepath, data)
写入 JSON 格式的数据到文件。
-- -------------------- ---- ------- ----- -- - --------------------- ----- ---- - - ----- ------ ---- --- ---- --- -- -- -- ---- -- ----------------------------- ------------- -- - ----------------- -------- ------------ -- - ------------------- ---
返回值：Promise，无返回值。
fs.writeUtf8(filepath, content)
写入 UTF-8 编码的内容到文件。
const fs = require('alinex-fs');
// 写入文件
fs.writeUtf8('./file.txt', 'Hello World!').then(() => {
console.log('文件写入成功!');
}).catch(err => {
console.error(err);
});返回值：Promise，无返回值。
fs.appendUtf8(filepath, content)
追加 UTF-8 编码的内容到文件。
const fs = require('alinex-fs');
// 追加文件
fs.appendUtf8('./file.txt', '\nMy name is Tom.').then(() => {
console.log('文件追加成功!');
}).catch(err => {
console.error(err);
});返回值：Promise，无返回值。
mkdir
fs.mkdir(dirpath)
创建目录。
const fs = require('alinex-fs');
// 创建目录
fs.mkdir('./data').then(() => {
console.log('目录创建成功!');
}).catch(err => {
console.error(err);
});返回值：Promise，无返回值。
copy
fs.copy(srcPath, destPath)
复制文件或目录。
-- -------------------- ---- ------- ----- -- - --------------------- -- ---- ------------------------- -------------------------- -- - ----------------------- ------------ -- - ------------------- --- -- ---- ---------------- ----------------- -- - ----------------------- ------------ -- - ------------------- ---
返回值：Promise，无返回值。
remove
fs.remove(filepath)
删除文件。
const fs = require('alinex-fs');
fs.remove('./file.txt').then(() => {
console.log('文件删除成功!');
}).catch(err => {
console.error(err);
});返回值：Promise，无返回值。
removeRecursive
fs.removeRecursive(dirpath)
删除目录及其所有文件。
const fs = require('alinex-fs');
fs.removeRecursive('./data').then(() => {
console.log('目录删除成功!');
}).catch(err => {
console.error(err);
});返回值：Promise，无返回值。
move
fs.move(srcPath, destPath)
移动文件或目录。
-- -------------------- ---- ------- ----- -- - --------------------- -- ---- ------------------------- -------------------------- -- - ----------------------- ------------ -- - ------------------- --- -- ---- ---------------- ----------------- -- - ----------------------- ------------ -- - ------------------- ---
返回值：Promise，无返回值。
symlink
fs.symlink(srcPath, destPath)
创建软链接。
const fs = require('alinex-fs');
// 创建软链接
fs.symlink('./file.txt', './link').then(() => {
console.log('软链接创建成功!');
}).catch(err => {
console.error(err);
});返回值：Promise，无返回值。
结语
alinex-fs 是一个非常实用的 Node.js 文件操作模块，给前端开发者提供了更加简便、高效的文件操作 API，提高了文件操作的可维护性。希望本文对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/73546