Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@runningsnail/node-operate-file

runningsnail3MIT1.0.3TypeScript support: included

node 操作文件

readme

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 时,表示进行深度遍历;