Preferences

Import :

const Preferences = brackets.getModule("JSUtils/Preferences")

Preferences

Kind: global class

• Preferences
  • new Preferences([prefs])
  • .getExcludedDirectories() ⇒ RegExp
  • .getExcludedFiles() ⇒ RegExp
  • .getMaxFileCount() ⇒ number
  • .getMaxFileSize() ⇒ number

new Preferences([prefs])

Constructor to create a default preference object.

Param	Type	Description
[prefs]	Object	preference object

preferences.getExcludedDirectories() ⇒ RegExp

Get the regular expression for excluded directories.

Kind: instance method of Preferences
Returns: RegExp - Regular expression matching the directories that should be excluded. Returns null if no directories are excluded.

preferences.getExcludedFiles() ⇒ RegExp

Get the regular expression for excluded files.

Kind: instance method of Preferences
Returns: RegExp - Regular expression matching the files that should be excluded. Returns null if no files are excluded.

preferences.getMaxFileCount() ⇒ number

Get the maximum number of files that will be analyzed.

Kind: instance method of Preferences

preferences.getMaxFileSize() ⇒ number

Get the maximum size of a file that will be analyzed. Files that are larger will be ignored.

Kind: instance method of Preferences