hqfile
v1.0.2
Published
How to operate files and folders
Downloads
13
Maintainers
Readme
下载
$ npm i hqfile
$ 或
$ yarn add hqfile
运行环境
node
引入包
const hq=require('hqfile');
或者
const {
readText,
readTextSync,
writeText,
writeTextSync,
copyImg,
copyImgSync,
getFiles,
getFilesSync,
createDir,
createDirSync,
isexists,
isexistsSync
} =require('hqfile');
方法说明
1.读取文件
readText('读取的文件名') 异步方法,返回Promise
readTextSync('读取的文件名') 同步方法,返回文件内容
注:如果文件不存在,返回{code:false,message:'文件不存在'}
2.写入文件
readText('写入的文件名','写入内容') 异步方法,返回Promise,值为**写入成功**
readTextSync('写入的文件名','写入内容') 同步方法,返回**写入成功**
注:如果文件不存在,会新建该文件
3.复制图片
copyImg('被复制的图片文件名','另存为的图片名') 异步方法,返回Promise,值为**复制成功**
copyImgSync('被复制的图片文件名','另存为的图片名') 同步方法,返回**复制成功**
注:如果被复制的图片不存在,返回{code:false,message:'文件不存在'};如果另存为的图片名目录不存在时,会新建文件夹
4.获取当前目录下的所有文件名
getFiles('文件夹名') 异步方法,返回Promise,值为文件名数组
getFilesSync('文件夹名') 同步方法,返回文件名数组
注:如果文件不存在,返回{code:false,message:'文件夹不存在'}
5.创建文件夹
createDir('文件夹名') 异步方法,返回Promise,值为**创建成功**
createDirSync('文件夹名') 同步方法,返回**创建成功**
6.判读文件或文件夹是否存在
isexists('文件夹名或文件名') 异步方法,返回Promise,值为Boolean
getFilesSync('文件夹名或文件名') 同步方法,返回Boolean
注:文件存在返回true,否则返回false