https://github.com/DataV-Team/FS
Promisify Node FS API
https://github.com/DataV-Team/FS
Last synced: 4 months ago
JSON representation
Promisify Node FS API
- Host: GitHub
- URL: https://github.com/DataV-Team/FS
- Owner: DataV-Team
- License: mit
- Created: 2019-07-09T01:36:40.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-26T15:15:07.000Z (about 3 years ago)
- Last Synced: 2025-02-01T16:02:09.243Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 113 KB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[ENGLISH](./README_EN.md)
FS
### 使用 Promise 封装了一些常用的文件系统方法（基于 Node.js 的 fs 文件系统）
- **[stat](#stat)**
读取文件状态
- **[mkDir](#mkDir)**
创建文件夹
- **[access](#access)**
连接文件
- **[copyDir](#copyDir)**
复制文件夹到指定位置，若文件夹已存在将被清空后进行复制操作
- **[readDir](#readDir)**
读取文件夹
- **[clearDir](#clearDir)**
递归清空文件夹，若文件夹不存在将被创建
- **[emptyDir](#emptyDir)**
递归清空文件夹
- **[readFile](#readFile)**
读取文件
- **[writeFile](#writeFile)**
写入文件
- **[dirForEach](#dirForEach)**
遍历文件夹
- **[fileForEach](#fileForEach)**
递归遍历文件
- **[unlinkDirFileByExtname](#unlinkDirFileByExtname)**
递归删除指定 extname 的文件
### npm 安装
```shell
$ npm install @jiaminghi/fs
```
### 使用
```javascript
import { readFile } from '@jiaminghi/fs'
// do something
```
示例
#### 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
```