# node-operate-file

**Repository Path**: btshjhewei/node-operate-file

## Basic Information

- **Project Name**: node-operate-file
- **Description**: node  操作 文件
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-22
- **Last Updated**: 2023-12-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# node 环境 文件操作

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

## API

- 获取指定文件夹下所有的文件路径


```typescript

getFilePaths(folder:string,options=ObtainFilesOptions):string[]

```

folder: 文件夹路径；

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



- 获取指定文件夹下所有的文件和文件夹 Stat 信息

```typescript

getFileAndFolder(folder:string,options=ObtainFilesOptions):Stats[]

```

folder: 文件夹路径；

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

- 获取指定文件夹下的所有文件和文件夹信息,并根据传入的函数过滤

```typescript

obtainFilesForFilter(folder: string, options: ObtainFilesOptions, fn: (stat: Stats) => void):Stats[]

```

folder: 文件夹路径；

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

fn: 回调函数

- 获取指定文件夹下的所有文件信息

```typescript

obtainFiles(folder: string, options?: ObtainFilesOptions):Stats[]

```

folder: 文件夹路径；

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