@runningsnail/node-operate-file
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

node 环境 文件操作

在写 node 脚本的时候,都不可避免的需要操作文件。因此将常用的遍历和操作文件及其文件的逻辑进行封装。

API

  • 获取指定文件夹下所有的文件路径
getFilePaths(folder:string,options=ObtainFilesOptions):string[]

folder: 文件夹路径;

options: 相关配置。deep 为 true 时,表示进行深度遍历;

  • 获取指定文件夹下所有的文件和文件夹 Stat 信息
getFileAndFolder(folder:string,options=ObtainFilesOptions):Stats[]

folder: 文件夹路径;

options: 相关配置。deep 为 true 时,表示进行深度遍历;

  • 获取指定文件夹下的所有文件和文件夹信息,并根据传入的函数过滤
obtainFilesForFilter(folder: string, options: ObtainFilesOptions, fn: (stat: Stats) => void):Stats[]

folder: 文件夹路径;

options: 相关配置。deep 为 true 时,表示进行深度遍历;

fn: 回调函数

  • 获取指定文件夹下的所有文件信息
obtainFiles(folder: string, options?: ObtainFilesOptions):Stats[]

folder: 文件夹路径;

options: 相关配置。deep 为 true 时,表示进行深度遍历;

Readme

Keywords

none

Package Sidebar

Install

npm i @runningsnail/node-operate-file

Weekly Downloads

1

Version

1.0.3

License

MIT

Unpacked Size

11.2 kB

Total Files

6

Last publish

Collaborators

  • runningsnail