Skip to content

Commit 21e15b0

Browse files
authored
doc: Add glob settings and v7 breaking changes (#268)
1 parent 98ee1e9 commit 21e15b0

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,18 @@ The [UNIX command](<http://en.wikipedia.org/wiki/Rm_(Unix)>) `rm -rf` for node.
22

33
Install with `npm install rimraf`.
44

5-
## Major Changes from v3 to v4
5+
## Major Changes
6+
7+
### v4 to v5
8+
9+
- There is no default export anymore. Import the functions directly
10+
using, e.g., `import { rimrafSync } from 'rimraf`.
11+
12+
### v3 to v4
613

714
- The function returns a `Promise` instead of taking a callback.
8-
- Globbing requires the `--glob` option to be set. (Removed in
9-
4.0 and 4.1, opt-in support added in 4.2.)
15+
- Globbing requires the `--glob` CLI option or `glob` option property
16+
to be set. (Removed in 4.0 and 4.1, opt-in support added in 4.2.)
1017
- Functions take arrays of paths, as well as a single path.
1118
- Native implementation used by default when available, except on
1219
Windows, where this implementation is faster and more reliable.
@@ -73,6 +80,8 @@ Options:
7380
`fs.rm` because that implementation does not support abort
7481
signals.
7582

83+
- `glob` Boolean flag to treat path as glob pattern, or an object
84+
specifying [`glob` options](https://github.com/isaacs/node-glob).
7685
- `filter` Method that returns a boolean indicating whether that
7786
path should be deleted. With async rimraf methods, this may
7887
return a Promise that resolves to a boolean. (Since Promises

0 commit comments

Comments
 (0)