@webscaffold/task-browser-sync
v0.1.0-alpha.7
Published
@webscaffold browser sync task
Downloads
25
Readme
@web-scaffold/task-browser-sync
WEB Scaffold
task for browser-sync.
Install
$ npm install --save-dev @webscaffold/task-browser-sync
Usage
const browserSync = require('@webscaffold/task-browser-sync');
await browser-sync(options);
This will run a browser-sync instance.
The module uses browser-sync internally so for more info on how you can define the paths check the modules options.
API
TODO: Fix the docs
browser-sync(paths, [options])
Returns a Promise for the paths to be removed. It will also log to the console the steps it took to do it.
paths
Type: array
Array of paths to be removed using rimraf
options.
options
Type: object
Options object that can be passed.
taskName
Type: string
Default: browser-sync
Task name that will be used by the logger to namespace the logs.
taskColor
Type: string
Default: #F3FFBD
The color used by the logger to log to the console the task output.
Licensing
MIT © Radu Micu