PathWatcher
Nodepod API / src / chokidar / PathWatcher
Interface: PathWatcher
Section titled “Interface: PathWatcher”Defined in: src/polyfills/chokidar.ts:81
Extends
Section titled “Extends”MiniEmitter
Properties
Section titled “Properties”cfg:
WatcherConfig
Defined in: src/polyfills/chokidar.ts:83
handlers
Section titled “handlers”handlers:
Map<string,Set<Listener>>
Defined in: src/polyfills/chokidar.ts:16
Inherited from
Section titled “Inherited from”MiniEmitter.handlers
handles
Section titled “handles”handles:
Map<string,FileWatchHandle>
Defined in: src/polyfills/chokidar.ts:84
initialised
Section titled “initialised”initialised:
boolean
Defined in: src/polyfills/chokidar.ts:86
terminated
Section titled “terminated”terminated:
boolean
Defined in: src/polyfills/chokidar.ts:85
vol:
MemoryVolume
Defined in: src/polyfills/chokidar.ts:82
Methods
Section titled “Methods”add(
targets):this
Defined in: src/polyfills/chokidar.ts:87
Parameters
Section titled “Parameters”targets
Section titled “targets”string | readonly string[]
Returns
Section titled “Returns”this
attachWatcher()
Section titled “attachWatcher()”attachWatcher(
target,filterFor?):void
Defined in: src/polyfills/chokidar.ts:94
Parameters
Section titled “Parameters”target
Section titled “target”string
filterFor?
Section titled “filterFor?”string
Returns
Section titled “Returns”void
close()
Section titled “close()”close():
Promise<void>
Defined in: src/polyfills/chokidar.ts:89
Returns
Section titled “Returns”Promise<void>
fire()
Section titled “fire()”fire(
name, …args):void
Defined in: src/polyfills/chokidar.ts:19
Parameters
Section titled “Parameters”string
…unknown[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”MiniEmitter.fire
gatherInitial()
Section titled “gatherInitial()”gatherInitial(
dir,queue):void
Defined in: src/polyfills/chokidar.ts:93
Parameters
Section titled “Parameters”string
() => void[]
Returns
Section titled “Returns”void
getWatched()
Section titled “getWatched()”getWatched():
Record<string,string[]>
Defined in: src/polyfills/chokidar.ts:90
Returns
Section titled “Returns”Record<string, string[]>
isExcluded()
Section titled “isExcluded()”isExcluded(
target):boolean
Defined in: src/polyfills/chokidar.ts:92
Parameters
Section titled “Parameters”target
Section titled “target”string
Returns
Section titled “Returns”boolean
off(
name,fn):this
Defined in: src/polyfills/chokidar.ts:18
Parameters
Section titled “Parameters”string
Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”MiniEmitter.off
on(
name,fn):this
Defined in: src/polyfills/chokidar.ts:17
Parameters
Section titled “Parameters”string
Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”MiniEmitter.on
resolvePath()
Section titled “resolvePath()”resolvePath(
raw):string
Defined in: src/polyfills/chokidar.ts:91
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string
unwatch()
Section titled “unwatch()”unwatch(
targets):this
Defined in: src/polyfills/chokidar.ts:88
Parameters
Section titled “Parameters”targets
Section titled “targets”string | readonly string[]
Returns
Section titled “Returns”this
watchSubtree()
Section titled “watchSubtree()”watchSubtree(
dir,level?):void
Defined in: src/polyfills/chokidar.ts:95
Parameters
Section titled “Parameters”string
level?
Section titled “level?”number
Returns
Section titled “Returns”void