Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents the options passable to BaseAdapter.watch

Hierarchy

  • IWatchOptions

Index

Properties

Optional change

Represents which types of update method to watch the Node path for

Optional glob

glob: undefined | string

Represents a Bash Shell Glob pattern to match paths with

NOTE: When using "Globstar", "**", the backend will watch recursively for sub-paths, which may incur a performance penalty

Optional inclusive

inclusive: undefined | false | true

Represents if IWatchOptions.path should watch for sub-paths instead of a singular Node path

Optional path

path: undefined | string

Represents a singular Node path to watch for changes

Optional recursive

recursive: undefined | false | true

Represents if IWatchOptions.path should watch for changes that happen in sub-paths as well.

NOTE: Only applicable whenever IWatchOptions.inclusive is true

Optional regex

regex: RegExp

Represents a Regular Expression to match paths with

NOTE: When using the "Global Match" flag, "g", the backend will watch recursively for sub-paths, which may incur a performance penalty

Optional type

Represents the type of Nodes to watch only for

Legend

  • Variable
  • Function
  • Type alias
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Property
  • Class
  • Class with type parameter
  • Enumeration

Generated using TypeDoc