Что делает строка «stream: true»?

Question

[Виталик Черный]

Что делает .pipe(browserSync.reload({stream:true}));, а точнее "stream: true". У Browsersync API есть про .reload( arg ) и .stream( opts ), но я не особо понял как это работает. В .reload({stream:true}) идет передача параметра (объекта). Это получается опция, но где про это почитать я не понимаю.

"use strict";

var gulp = require("gulp"),
		sass = require("gulp-sass"),
		browserSync = require("browser-sync").create();

gulp.task("sass", function() {
	return gulp.src("app/sass/**/*")
	.pipe(sass())
	.pipe(gulp.dest("app/css"))
	.pipe(browserSync.reload({stream:true}));
});

gulp.task("browser-sync", function() {
	browserSync.init({
		server: {
			baseDir: "app"
		},
		notify: false
	});
});

gulp.task("watch", ["sass", "browser-sync"], function() {
	gulp.watch("app/sass/**/*", ["sass"]);
	gulp.watch("app/*.html", browserSync.reload);
	gulp.watch("app/**/*.js", browserSync.reload);
});

Comments

[Сергей delphinpro]

Да нигде особо не расписано. Почитать можно только офф доку и исходники браузер-синка.

[Виталик Черный]

Сергей: А каким образом я должен понять что куда писать и как другие люди это узнали? Битва экстрасенсов?)

[Сергей delphinpro]

Виталик Черный: Вы моё предложение до конца прочитали? Оно короткое, вообще-то =) Из исходников Вы же программист, умеете читать код.
https://github.com/BrowserSync/browser-sync/blob/m...
Если передан stream: true будет возвращен поток, так же как при вызове метода stream()

[Сергей delphinpro]

Собственно, там и написано, что опция устаревшая, и вместо нее следует использовать метод stream()
Поэтому и в документации нигде не упоминается.

Answer 1

[alvvi]

Не знаю, откуда взялся этот объект, в документации к самому методу reload, которую можно найти в исходниках, написано то же, что и в документации на сайте: https://browsersync.io/docs/api#api-reload

/**
 * The `reload` method will inform all browsers about changed files and will either cause the browser to refresh, or inject the files where possible.
 *
 * @method reload
 * @param {String|Array|Object} [arg] The file or files to be reloaded.
 * @returns {*}
 */

Передавать туда {stream: true} - бессмысленно, возможно раньше это и имело смысл, но документацию по прошлым версиям я найти не сумел.

P.S. .stream( opts ) - отдельный метод, прямого отношения к .reload он не имеет.

Comments

[Виталик Черный]

Бей {stream: true} не запускается.

[Сергей delphinpro]

Илья Ростопка
https://github.com/BrowserSync/browser-sync/blob/m...