Skip to content
This repository was archived by the owner on Jun 24, 2025. It is now read-only.

Commit e800974

Browse files
committed
README: add options.read documentation
1 parent aaf405a commit e800974

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@ Default: `10`
9696

9797
Wait for `readDelay` milliseconds before reading the file.
9898

99+
#### options.read
100+
Type: `Boolean`
101+
Default: `true`
102+
103+
Setting this to `false` will return `file.contents` as null and not read the file at all. Most useful as an optimization if your plugins pipeline doesn't make use of the file contents (e.g. `gulp-clean`), or to avoid reading the file twice if you use `gulp.src()` inside the callback instead of the file object that is passed as argument.
104+
99105
### Methods
100106

101107
Returned `Stream` from constructor has some useful methods:

0 commit comments

Comments
 (0)