Skip to content

Commit c8bf7bc

Browse files
committed
docs: add desc of rm function
1 parent 765bc3e commit c8bf7bc

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,18 @@ We are rewriting `fs` APIs one by one.
3838
encoding?: string; //
3939
withFileTypes?: boolean; //
4040
recursive?: boolean; //
41+
concurrency?: number; //
4142
};
4243
```
43-
- **Return Type Diff**: `Buffer` return not supported yet.
44-
- **Performance**: TBD
45-
- **Supported Version**: TBD
46-
- **Notes**:
47-
- ✨ Supports `options.concurrency` to control parallelism.
44+
- **Return Type**:
45+
```ts
46+
string[]
47+
| {
48+
name: string, //
49+
parentPath: string, //
50+
isDir: boolean //
51+
}[]
52+
```
4853

4954
### `readFile`
5055

@@ -64,7 +69,21 @@ We are rewriting `fs` APIs one by one.
6469

6570
### `rm`
6671

67-
- **Status**: ❌
72+
- **Node.js Arguments**:
73+
```ts
74+
path: string; //
75+
options?: {
76+
force?: boolean; //
77+
maxRetries?: number; //
78+
recursive?: boolean; //
79+
retryDelay?: number; //
80+
concurrency?: number; //
81+
};
82+
```
83+
- **Return Type**:
84+
```ts
85+
void
86+
```
6887

6988
### `rmdir`
7089

0 commit comments

Comments
 (0)