Skip to content

Commit

Permalink
docs: new default options
Browse files Browse the repository at this point in the history
  • Loading branch information
shakyShane committed Dec 29, 2017
1 parent 863bac1 commit 34ce044
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions lib/default-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
* @module BrowserSync.options
*/
module.exports = {

/**
* @property cwd
* @type string
* @since 2.23.0
*/

/**
* Browsersync includes a user-interface that is accessed via a separate port.
* The UI allows to controls all devices, push sync updates and much more.
Expand Down Expand Up @@ -35,6 +42,35 @@ module.exports = {
*/
watchEvents: ["change"],

/**
* Watch files automatically
* @property watch
* @type Boolean
* @default false
* @since 2.23.0
*/
watch: false,

/**
* Patterns for any watchers to ignore. Anything provided here
* will end up inside `watchOptions.ignored`
* @property ignore
* @type Array
* @default []
* @since 2.23.0
*/
ignore: [],

/**
* Serve an index.html file for all non-asset routes. Useful
* when using client-routers
* @property single
* @type Boolean
* @default false
* @since 2.23.0
*/
single: false,

/**
* File watching options that get passed along to [Chokidar](https://github.com/paulmillr/chokidar).
* Check their docs for available options
Expand Down

0 comments on commit 34ce044

Please sign in to comment.