Skip to content

daiyunchao/fs_sync_tool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NodeJs 文件操作 同步执行库 提供了删除文件夹 修改文件所属用户(linux系统)

说明: 本库使用ES6 编写 ,请确保你的Node版本支持 class Promise async await 功能

安装:

npm i fs_sync_tool --save -d

使用:

//引用:
const FsSyncTool=require("fs_sync_tool");


//创建文件:
FsSyncTool.outputFile('./newFile.txt', '12345');

//创建文件,如果已存在则覆盖
FsSyncTool.outputFileAndCoverOld('./newFile.txt', '678910');

//创建文件,如果文件已存在,则在该文件末尾添加内容
FsSyncTool.outputFileOrAppendContent('./newFile.txt', '678910');

//检查文件是否为空
FsSyncTool.dirIsEmpty('./test_dir')

//判断是否是文件夹
FsSyncTool.isDir('./newFile.txt')

//判断是否是文件夹,如果不是文件夹则抛出异常
FsSyncTool.isDirAndThrowError('./newFile.txt')

//判断文件路径是否存在
FsSyncTool.isExistPath('./sss');

//创建文件夹,如果文件夹存在则抛出异常
FsSyncTool.createDir('./test_dir')

//创建文件夹,如果存在则覆盖
FsSyncTool.createDirAndCoverOld('./test_dir').then(xxx);

//获取文件utf8内容
FsSyncTool.getFileUTF8Content("./test_files_dir/testFile.txt");

//获取文件夹的子文件夹或文件
FsSyncTool.getChildFileOrDir('./test_files_dir');

//拷贝文件或文件夹,如果源文件夹或文件不存在则抛出异常,如果目标文件或文件夹已存在则抛出异常
FsSyncTool.copyFileOrDir(sourcePath, targetPath).then(xxx);

//拷贝文件或文件夹,如果目标文件夹已存在则覆盖,如果源文件夹或文件不存在则抛出异常
FsSyncTool.copyFileOrDirCoverOld("./test_files_dir", "./test_dir_copy").then(xxx);

//修改文件或文件夹的用户归属(文件)
FsSyncTool.changeFileOrDirUser("./test_files_dir/testFile.txt", "daiyc");

//修改文件或文件夹的用户归属(文件夹)
FsSyncTool.changeFileOrDirUser("./test_files_dir", "daiyc");

//删除文件夹
FsSyncTool.removeDir("./test_files_dir").then(xxxx);

//删除文件夹或文件
FsSyncTool.removeFileOrDir("./test_dir_copy/testFile.txt").then(xxxx);


全部方法:

方法名 参数 是否是Promise类型 返回值 说明
删除文件夹 removeDir path 需要删除文件夹的路径 Promise 删除文件夹,如果参数不为有效文件夹路径,返回错误 throw Error
删除文件或文件夹 removeFileOrDir path 需要删除文件夹的路径 Promise 该方法可删除文件或文件夹 如果文件路径无效 则会 throw Error
文件夹是否为空 dirIsEmpty path 需要判断的文件夹路径 如果空则返回: true 如果不是空返回: false 路径无效 throw Error
是否为文件夹 isDir path 需要判断的文件夹路径 如果是文件夹: true 如果不是文件夹: false 路径无效直接返回false
是否为文件夹,如果不是抛出异常 isDirOrThrowError path 需要判断的文件夹路径 如果是文件夹: true 路径无效 throw Error
是否为文件夹,如果不是则抛出异常 isDirAndThrowError path 需要判断的文件夹路径 如果是文件夹: true 如果不是文件夹: false 路径无效 throw Error
路径是否真实有效 isExistPath path 需要判断的文件夹或文件路径 有效路径: true 无效路径: false
路径是否真实有效,如果不存在则抛出异常 isExistPathOrThrowError path 需要判断的文件夹或文件路径 有效路径: true 如果不存在 throw Error
创建文件夹 createDir path 要创建文件夹的路径 如果文件夹已存在,throw Error
创建文件夹如果文件夹已存在,覆盖该文件夹 createDirAndCoverOld path 要创建文件夹的路径 Promise
获取文件UTF8内容 getFileUTF8Content path 文件路径 文件内容 如果文件路径无效 throw Error path not exist ,如果是文件夹, throw Error path is dir
获取文件夹的子文件或子文件夹 getChildFileOrDir path 文件夹路径 Array文件和文件夹列表 路径无效 throw Error
将文件输入到指定文件中 outputFile path 文件路径 文件已存在,throw Error file is exist
将文件输入到指定文件中,如果文件存在则覆盖 outputFileAndCoverOld path 文件路径 文件已存在则覆盖文件,如果path参数指定的是一个文件夹,则 throw Error path is dir
将文件输入到指定文件中,如果文件存在则追加 outputFileOrAppendContent path 文件路径 文件已存在则在原文件中追加内容,如果path参数指定的是一个文件夹,则 throw Error path is dir
修改文件或文件夹所属用户 changeFileOrDirUser path 文件或文件夹路径 user 所属用户的名称 修改文件或文件夹的所属用户,使用shell,只适用于linux
拷贝文件或文件夹 copyFileOrDir sourcePath 源文件路径 targetPath 目标文件路径 ncpLimit 拷贝文件层级 默认值为:16 源路径不存在或目标路径已存在,都会 throw Error
拷贝文件或文件夹,如果目标文件或文件夹已存在则会覆盖 copyFileOrDirCoverOld sourcePath 源文件路径 targetPath 目标文件路径 ncpLimit 拷贝文件层级 默认值为:16 Promise 源路径不存在 throw Error

About

nodeJs 操作文件 同步的方法合集

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published