Skip to content

Commit 15c838e

Browse files
committed
docs: updated cwd, watch & callbacks inline documentation
1 parent bb7bef1 commit 15c838e

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

lib/default-config.js

+24-8
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,6 @@
33
*/
44
module.exports = {
55

6-
/**
7-
* Current working directory
8-
* @property cwd
9-
* @type String
10-
* @since 2.23.0
11-
*/
12-
136
/**
147
* Browsersync includes a user-interface that is accessed via a separate port.
158
* The UI allows to controls all devices, push sync updates and much more.
@@ -44,7 +37,11 @@ module.exports = {
4437
watchEvents: ["change"],
4538

4639
/**
47-
* Watch files automatically
40+
* Watch files automatically - this should be used as an
41+
* alternative to the `files` option. When this option is used, some directories
42+
* will be ignored automatically such as `node_modules` `bower_components` `.sass-cache`
43+
* `.vscode` `.git` `.idea`
44+
*
4845
* @property watch
4946
* @type Boolean
5047
* @default false
@@ -173,6 +170,25 @@ module.exports = {
173170
* @since 2.18.0
174171
*/
175172

173+
/**
174+
* Current working directory
175+
* @property cwd
176+
* @type String
177+
* @since 2.23.0
178+
*/
179+
180+
/**
181+
* Register callbacks via a regular option - this can be used
182+
* to get access the Browsersync instance in situations where you
183+
* cannot provide a callback via the normal API (for example, in a Gruntfile)
184+
*
185+
* **Note**: Only the `ready` callback is currently supported here.
186+
*
187+
* @property callbacks
188+
* @type Object
189+
* @param {Function} ready
190+
*/
191+
176192
/**
177193
* Clicks, Scrolls & Form inputs on any device will be mirrored to all others.
178194
* @property ghostMode

0 commit comments

Comments
 (0)