1.node基本API
1.1 fs模块
1.1.1 fs.writeFile()
fs.writeFile()默认情况下,此 API 会替换文件的内容(如果文件已经存在)。
可以通过指定标志来修改默认的行为:
fs.writeFile('/Users/joe/test.txt', content, { flag: 'a+' }, err => {})
可能会使用的标志有:
- r+ : 打开文件用于读写。
- w+ : 打开文件用于读写,将流定位到文件的开头。如果文件不存在则创建文件。
- a 打开文件用于写入,将流定位到文件的末尾。如果文件不存在则创建文件。
- a+ 打开文件用于读写,将流定位到文件的末尾。如果文件不存在则创建文件。
1.1.2 fs.appendFile()
将内容追加到文件末尾
1.1.3 fs.access()
使用 fs.access() 检查文件夹是否存在以及 Node.js 是否具有访问权限。
1.1.4 fs.mkdir() 或 fs.mkdirSync()
使用 fs.mkdir() 或 fs.mkdirSync() 可以创建新的文件夹。
try {
if (!fs.existsSync(folderName)) { //existsSync检查是否存在文件夹
fs.mkdirSync(folderName) // 创建
}
} catch (err) {
console.error(err)
}
1.1.5 fs.readdir() 或 fs.readdirSync()
使用 fs.readdir() 或 fs.readdirSync() 可以读取目录的内容。
const folderPath = './src' // 路径
fs.readdirSync(folderPath)
可以获取完整的路径:
fs.readdirSync(folderPath).map(fileName => {
return path.join(folderPath, fileName)
})
也可以过滤结果以仅返回文件(排除文件夹):
const isFile = fileName => {
return fs.lstatSync(fileName).isFile()
}
fs.readdirSync(folderPath).map(fileName => {
return path.join(folderPath, fileName)
})
.filter(isFile)
1.1.6 fs.rename() 或 fs.renameSync()
使用 fs.rename() 或 fs.renameSync() 可以重命名文件夹。 第一个参数是当前的路径,第二个参数是新的路径:
1.1.7 fs.rmdir() 或 fs.rmdirSync()
使用 fs.rmdir() 或 fs.rmdirSync() 可以删除文件夹。删除包含内容的文件夹可能会更复杂。
fs-extra 模块是 fs 模块的直接替代品,在其之上提供了更多的功能。
在此示例中,需要的是 remove() 方法。
npm install fs-extra //安装
并像这样使用它:
const fs = require('fs-extra')
const folder = '/Users/joe'
fs.remove(folder, err => {
console.error(err)
})
也可以与 promise 一起使用:
fs.remove(folder)
.then(() => {
//完成
})
.catch(err => {
console.error(err)
})
1.2 path路径模块
-
path.sep
路径段分隔符,在 Windows 上是 \,在 Linux/macOS 上是 /
-
path.delimiter
路径定界符,在 Windows 上是 ;,在 Linux/macOS 上是 :
-
path.basename()
返回路径的最后一部分。 第二个参数可以过滤掉文件的扩展名:
require('path').basename('/test/something') //something
require('path').basename('/test/something.txt') //something.txt
require('path').basename('/test/something.txt', '.txt') //something
- path.dirname()
返回路径的目录部分:
- path.extname()
返回路径的扩展名部分。
- path.isAbsolute()
如果是绝对路径,则返回 true
- path.join()
连接路径的两个或多个部分:
- path.normalize()
当包含类似 .、.. 或双斜杠等相对的说明符时,则尝试计算实际的路径:
- path.parse()
解析对象的路径为组成其的片段:
root: 根路径。
dir: 从根路径开始的文件夹路径。
base: 文件名 + 扩展名
name: 文件名
ext: 文件扩展名
例如:
require('path').parse('/users/test.txt')
{
root: '/',
dir: '/users',
base: 'test.txt',
ext: '.txt',
name: 'test'
}
- path.relative()
接受 2 个路径作为参数。 基于当前工作目录,返回从第一个路径到第二个路径的相对路径。
path.resolve()