[中文](./README.md)
FS
### Encapsulating some common file system methods with Promise (based Node.js - fs)
- **[stat](#stat)**
fs.stat.
- **[mkDir](#mkDir)**
fs.mkdir.
- **[access](#access)**
fs.access.
- **[copyDir](#copyDir)**
Copy the folder to the specified location.
- **[readDir](#readDir)**
fs.readdir.
- **[clearDir](#clearDir)**
Recursively empty the specified folder.
- **[emptyDir](#emptyDir)**
Recursively empty the specified folder.
- **[readFile](#readFile)**
fs.readFile.
- **[writeFile](#writeFile)**
fs.writeFile.
- **[dirForEach](#dirForEach)**
Traverse all folders.
- **[fileForEach](#fileForEach)**
Recursively traverse all files.
- **[unlinkDirFileByExtname](#unlinkDirFileByExtname)**
Delete the specified extname file.
### Install with npm
```shell
$ npm install @jiaminghi/fs
```
### Use
```javascript
import { readFile } from '@jiaminghi/fs'
// do something
```
Examples
#### stat
```typescript
type stat = (
path: fs.PathLike,
options: fs.StatOptions = { bigint: false }
) => Promise
```
#### mkDir
```typescript
type mkDir = (path: fs.PathLike, options: fs.MakeDirectoryOptions = {}) => Promise
```
#### access
```typescript
type access = (path: fs.PathLike, mode = fs.constants.F_OK) => Promise
```
#### copyDir
```typescript
type copyDir = (path: fs.PathLike, dest: string) => Promise
```
#### readDir
```typescript
type readDir = (path: fs.PathLike) => Promise
```
#### clearDir
```typescript
type clearDir = (path: fs.PathLike) => Promise
```
#### emptyDir
```typescript
type emptyDir = (path: fs.PathLike) => Promise
```
#### readFile
```typescript
type readFile = (
path: fs.PathLike,
options: { encoding: string; flag?: string } = { encoding: 'utf8' }
) => Promise
```
#### writeFile
```typescript
type writeFile = (
path: fs.PathLike,
data: any,
option: fs.WriteFileOptions = 'utf8'
) => Promise
```
#### dirForEach
```typescript
type dirForEach = (path: fs.PathLike, callback: (path: string) => any) => Promise
```
#### fileForEach
```typescript
type fileForEach = (path: fs.PathLike, callback: (path: string) => any) => Promise
```
#### unlinkDirFileByExtname
```typescript
type unlinkDirFileByExtname = (path: fs.PathLike, extnames: string[] = []) => Promise
```