Prevent implicit highWaterMark option set by through.obj

[ghost]

through.obj(...) is documented as a shorthand for through({ objectMode: true }, ...) but in the source through2.js:88 it also sets the highWaterMark to 16.

This appears to cause problems when there's more than 16 files and there's nothing consuming the stream (i.e. gulp-notify is the last plugin in the pipeline and the stream is not returned) - see gulpjs/gulp#716. I think it also accounts for issues #96, #94 and #83 here.

Not sure if the change in this pull request is correct - I don't know much about node streams to be honest, but it seemed to correct the problem on my machine. On the other hand, the stream docs say highWaterMark has a default value of 16 anyway... so I don't know.

If there isn't an easy solution, maybe mention the need to consume the stream after notify() in the readme?

[coldasflux]

This is still an issue. Ran into the same.
Consuming the stream after notify with smth like pipe(size()) (gulp-size) will prevent this.

Would be nice to have things clarified, why the merge-request was not accepted.

[mikaelbr]

Hm. I see. I don't think this PR fixes it, though. As @parsnick mentioned, this is the default in node also. If I may ask, in what case don't you want to consume the producing stream? gulp-notify streams are intended as pass through streams, either before .dest or returned in a task.

[coldasflux]

I'm using notify at the end of a pipe, like so...

gulp.src(...)
   .pipe(gulp.dest(...))
   .pipe(whatever())
   .pipe(notify({ onLast: true, message: '...'))

I want to be notified if the task has finished. If errors occur I won't be notified as I expect to be notified while watching.

[mikaelbr]

But you use that in a task, right? Should you return the stream created, and it'll work as expected, or am I missing something?

[coldasflux]

Returning the stream does it! I did miss this in certain tasks..

gulp.task('foo', function () {
   return gulp.src(...)
      .pipe(gulp.dest(...))
      .pipe(whatever())
      .pipe(notify({ onLast: true, message: '...'))
   ;
});

Thx a lot for pointing this out! :)