nodejs入门API之fs模块

F_OK ：表明文件对调用进程可见。可以用来判断文件是否存在，但没有有rwx权限说明。
R_OK ：表明调用进程可以读取文件。
W_OK ：表明调用进程可以写入文件。
X_OK ：表明调用进程可以执行文件。在window系统上无效，表现的像fs.constants.F_OK。

COPYFILE_EXCL ：如果目标路径已经存在，则拷贝操作将失败。
COPYFILE_FICLONE ：拷贝操作将尝试创建写时拷贝连接。如果底层平台不支持写时拷贝，则使用备选拷贝机制。
COPYFILE_FICLONE_FORCE ：拷贝操作将尝试创建写时拷贝连接。如果底层平台不支持写时拷贝，则拷贝失败。

O_RDONLY ：表明打开文件用于只读访问。
O_WRONLY ：表明打开文件用于只写访问。
O_RDWR ：表明打开文件用于读写操作。
O_CREAT ：表明如果文件不存在则创建文件。
O_EXCL ：表明如果设置了O_CREAT标志且文件已存在，则打开文件应该失败。
O_NOCTTY ：表明如果路径表示中断设备，则打开该路径不应该造成该终端变成进程的控制终端（如果进程还没有终端）。
O_TRUNC ：表明如果文件存在且是常规文件、并且文件成功打开以进行写入访问，且长度应截断为零。
O_APPEND ：表明数据将会追加到文件的末尾。
O_DIRECTORY ：表明如果路径不是目录，则打开应该失败。
O_NOATIME ：表明文件系统的读取访问不再导致于文件相关联的atime信息的更新。仅在Linux系统上有效。
O_NOFOLLOW ：表明如果路径是符号连接，则打开应该失败。
O_SYNC ：表明文件是为同步I/O打开的，写入操作将会等待文件的完整性。
O_DSYNC ：表明文件是为同步I/O打开的，写入操作将会等待数据的完整性。
O_SYMLINK ：表明打开符号连接自身，而不是它指向的资源。
O_DIRECT ：表明将尝试最小化文件I/O的缓冲效果。
O_NONBLOCK ：表明在可能的情况下以非阻塞模式打开文件。
UV_FS_O_FILEMAP ：当设置后，将会使用内存文件的映射来范文文件。此标志仅在windows系统上有效，其它系统此标志会被忽略。

S_IFMT ：用于提取文件类型代码的位掩码。
S_IFREG ：表示常规文件。
S_IFDIR ：表示目录。
S_IFCHR ：表示面向字符的设备文件。
S_IFBLK ：表示面向块的设备文件。
S_IFIFO ：表示FIFO或管道。
S_IFLNK ：表示符号连接。
S_IFSOCK ：表示套接字。

S_IRWXU ：表明所有者可读、可写、可执行。
S_IRUSE ：表明所有者可读。
S_IWUSR ：表明所有者可写。
S_IXUSR ：表明所有者可执行。
S_IRWXG ：表明群组可读、可写、可执行。
S_IRGRP ：表明群组可读。
S_IWGRP ：表明群组可写。
S_IXGRP ： 表明群组可执行。
S_IRWXO ：表明群组可读、可写、可执行。
S_IROTH ：表明其他人可读。
S_IWOTH ：表明其他人可写。
S_IXOTH ：表明其他人可执行。

fs.access(path[,mode],callback);//异步：回调函数调用时将传入可能的错误参数，如果权限检查通过就不会传入参数。
fs.accessSync(path[,mode]);//同步：如果权限检查不通过则抛出Error。否则通过的话就返回undefined。

fs.appendFile(path, data[, options], callback);//异步：options可以配置文件encoding、mode、flag【字符编码、权限值、文件可操作标志符】，如果写入一个字符串值只表示字符编码。
//callbakc：当操作不可操作时会传入error对象
fs.appendFileSync(path,data[,options]);//同步

fs.chmod(path,mode,callback);//异步：回调函数除了可能的异常对象，没有其他参数。
fs.chmodSync(path,mode);//同步

fs.chown(path,uid,gid,callback);//异步：uid-所有者id、gid-群组id
fs.chownSync(path,uid,gid);//同步

fs.close(fd,callback);//异步
fs.closeSync(fd);//同步

fs.copyFile(src,dest[,flags],callback);//异步
//src:要拷贝的文件
//dest：拷贝操作的目标文件名
//flags:用于拷贝操作修饰符，详细见第一节1.7.2
//callback:除了可能发生的错误err对象没有其他参数
fs.copyFileSync(src,dest[,flags])

path  |  | 
options  | 

path  |  | 
options  | 

//如果路径存在，则返回 true，否则返回 false。
//示例：
if (fs.existsSync(‘/etc/passwd‘)) {
  console.log(‘文件已存在‘);
}

fs.fchmod(fd,mode,callback);//异步修改文件权限
fs.fchmodSync(fd,mode);//同步修改文件权限
//fd--文件描述符；mode--权限（0o666）；callback除了可能出现的error对象没有其他参数

fs.fchown(fd,uid,gid,callback);//异步修改文件所有者和群组
fs.fchownSync(fd,uid,gid);//同步修改文件所有者和群组
//fd--文件描述符；uid--所有者id；gid--群组id；callback除了出现可能的异常传入error参数以外不需要传入其他参数

fs.fdatasync(fd,callback);//异步
fs.fdatasyncSync(fd);//同步

fs.fstat(fd[,options],callback);//异步：optiosn只有一个bigint字段，默认为false，意思是生成普通fs.stats对象，否则生成BigintStats对象
fs.fstatSync(fd,[options]);//同步

fs.fsync(fd,callback);//异步实现文件同步
fs.fssyncSync(fd);//同步实现文件同步

fs.ftruncate(fd[, len], callback);//异步
fs.ftruncateSync(fd[,len]);//同步

fs.futimes(fd, atime, mtime, callback)；//异步
fs.futimesSync(fd, atime, mtime)//同步

fs.lchmod(path, mode, callback);//异步:只适应macOS
fs.lchmodSync(path, mode)//同步

fs.lchown(path, uid, gid, callback);//异步
fs.lchownSync(path, uid, gid);//同步

fs.link(existingPath, newPath, callback)；//异步
fs.linkSync(existingPath, newPath);//同步

fs.lstat(path[, options], callback)；//异步
fs.lstatSync(path[, options]);//同步

fs.mkdir(path[, options], callback)；//异步
fs.mkdirSync(path[, options])；//同步

fs.mkdtemp(prefix[, options], callback)；//异步
fs.mkdtempSync(prefix[, options]);//同步

fs.open(path[, flags[, mode]], callback)；//异步打开文件：回调函数的参数（err,fd）
fs.openSync(path[, flags, mode]);//同步打开文件：返回文件描述符fd

fs.opendir(path[, options], callback);//异步打开文件夹,回调函数的参数（err,dir）,dir一个文件目录流对象（fs.dir对象）
fs.opendirSync(path[, options]);//同步打开文件夹：返回fs.dir

fs.read(fd, buffer, offset, length, position, callback);//异步读取。
fs.readSync(fd, buffer, offset, length, position);//同步读取。返回 bytesRead 的数量。
//fd--文件描述符
//buffer--数据将写入缓冲区
//offset--buffer写入的偏移量
//length--指定读取的字节数
//position--指定开始读取的位置
//callback--三个参数：err、bytesRead、buffer

fs.readdir(path[, options], callback);//异步：回调函数有两个参数（err,files）
fs.readdirSync(path[, options]);//同步：返回文件名数组

fs.readFile(path[, options], callback);//异步
fs.readFileSync(path[, options]);//同步:返回文件内容data|
//path  |  |  |  文件名或文件描述符。如果将文件描述符指定为 path，则不会自动关闭它。
//options:{encoding,flag}任何指定的文件描述符都必须支持读取。
//callback(err,data)--data|

fs.readlink(path[, options], callback);//异步
fs.readlinkSync(path[, options]);//同步
//path-- |  | 
//options--|
//callback(err,linkstring);//当设置encoding为buffer时，文件连接将作为buffer类型，否则为string类型

fs.realpath(path[, options], callback);//异步
fs.realpathSync(path[, options]);//同步
//path--相对路径
//options--字符编码|
//callback(err,resolvedPath);resolvedPath--绝对路径

fs.realpath.native(path[, options], callback);//异步
fs.realpathSync.native(path[, options]);//同步
//在 Linux 上，当 Node.js 与 musl libc 链接时，procfs 文件系统必须挂载在 /proc 上才能使此功能正常工作。 Glibc 没有这个限制。

fs.rename(oldPath, newPath, callback);//异步
fs.renameSync(oldPath, newPath);//同步
//异步地将 oldPath 上的文件重命名为 newPath 提供的路径名。 如果 newPath 已存在，则覆盖它。

fs.rmdir(path[, options], callback);//异步
fs.rmdirSync(path[, options]);//同步
//path--文件夹路径
//options--{emfileWait,maxBusyTries,recursive}
//emfileWait--如果发生错误，以1毫秒的频率进行回退，重试操作。该参数默认值1000毫秒，如果在这个设定的时间内重试不成功则抛出错误。
//maxBusyTries--以100毫秒为频率进行回退，重试操作。该操作默认值3，表示重试操作3次。
//recursive--如果设置为true，则执行递归删除目录，如果path不存在不抛出错误，重试该操作，知道超出重试时间或次数。
//--只能删除空文件夹

fs.stat(path[, options], callback)；//异步
fs.statSync(path[, options]);//同步--返回fs.stats
//options
//callback(err,stats)

fs.symlink(target, path[, type], callback);//异步
fs.symlinkSync(target, path[, type]);//同步
//target--目标文件或目录
//path--链接
//type--仅在windows上有用，用来指定文件类型（dir、file、junction），如果找到指定的类型则使用file类型。
//callback(err)

fs.truncate(path[, len], callback);//异步callback(err)
fs.unlink(path, callback);//同步--返回undefined
//len--指定截取文件内容的字节数，从文件内容起始位置到len。（默认参数为0，表示截取文件所有内容）
//这个方法尽量不要使用fd（文件描述符）可能导致出错，尽量使用文件路径作为path，使用fd的操作可以使用fs.ftruncate()

fs.unlink(path, callback);//异步：callback(err)
fs.unlinkSync(path);//同步--返回undefined
//path--可使用路径字符串，也可以使用fd文件描述符

fs.unwatchFile(filename[, listener]);
//filename--文件名称
//listener--监听器名称

fs.utimes(path, atime, mtime, callback);//callback(err)
fs.utimesSync(path, atime, mtime)
//path--文件、文件夹
//atime--Unix纪元时间的数字值、Date对象、或类似 ‘123456789.0‘ 的数值字符串。
//mtime--时间戳

fs.watch(filename[, options][, listener]);
//filename--监听的文件或目录
//options|object--{persistent,recursive}--persistent指示文件已被监听，进程是否继续运行；recursive--指示应该监听所有子目录还是监听当前目录。
//listener(eventType,filename)--监听器回调函数
//eventType--事件类型‘rename‘、‘change‘
//filename--触发事件的文件名称

fs.watchFile(filename[, options], listener)；//该方法与fs.watch()非常类是，watch()用于设置文件和目录的监听事件；但watchFile只能设置文件的监听事件
//filename--文件名称
//options
//listener(current,previous)
//current--当前最近修改的记录对象：比如修改的时间curent.mtime
//previous--之前最近修改的记录对象

fs.write(fd, string[, position[, encoding]], callback)//异步
fs.writeSync(fd, buffer[, offset[, length[, position]]])//同步--返回一个nummber值，表示写入的字节数
//fd--文件描述符
//string--数据。如果string不是一个字符串，会被强制转换成字符串。
//position--指定文件开头的偏移量（数据应该写入的位置）。如果position不是number原始类型则从最开始的位置写入。
//encoding--string【数据】期望的字符串编码。
//callback(err,written,string)
//written--指定字符串要被写入的字节数

fs.writeFile(file, data[, options], callback);//异步
fs.writeFileSync(file, data[, options]);//同步
//当 file 是一个文件名时，异步地将数据写入到一个文件，如果文件已存在则覆盖该文件。 data 可以是字符串或 buffer。
//当 file 是一个文件描述符时，行为类似于直接调用 fs.write()（建议使用）。 请参阅以下有关使用文件描述符的说明。
//如果 data 是一个 buffer，则 encoding 选项会被忽略。
//position|
//--encoding:字符编码
//--mode--配置权限
//flag--配置文件标志

fs.write(fd, Buffer.from(data, options.encoding), callback);

fs.writev(fd, buffers[, position], callback);//异步
fs.writevSync(fd, buffers[, position]);//同步--返回写入的字节数
//fd--文件描述符
//buffers--
//position--指定文件开头的偏移量
//callback(err,bytesWritten,buffers)
//bytesWritten--写入的字节数