- Preparing search index...
- The search index is not available
pathlib-js
Constructors
constructor
- new PathWatcher(options?: WatchOptions): PathWatcher
-
Parameters
-
Optional options: WatchOptions
Methods
add
- add(paths: string | default | readonly string[] | readonly default[]): FSWatcher
-
Returns FSWatcher
close
- close(): Promise<void>
-
Returns Promise<void>
getWatched
- getWatched(): { [k: string]: T }
-
Returns { [k: string]: T }
on
- on(event: "ready", listener: (() => void)): PathWatcher
-
Parameters
-
event: "ready"
-
listener: (() => void)
- on(event: "add" | "addDir" | "change", listener: ((path: default, stats?: Stats) => void)): PathWatcher
-
Parameters
-
event: "add" | "addDir" | "change"
-
listener: ((path: default, stats?: Stats) => void)
-
- (path: default, stats?: Stats): void
-
Returns void
- on(event: "all", listener: ((eventName: "add" | "addDir" | "change" | "unlink" | "unlinkDir", path: default, stats?: Stats) => void)): PathWatcher
-
Parameters
-
event: "all"
-
listener: ((eventName: "add" | "addDir" | "change" | "unlink" | "unlinkDir", path: default, stats?: Stats) => void)
-
- (eventName: "add" | "addDir" | "change" | "unlink" | "unlinkDir", path: default, stats?: Stats): void
-
Parameters
-
eventName: "add" | "addDir" | "change" | "unlink" | "unlinkDir"
-
-
Optional stats: Stats
Returns void
- on(event: "error", listener: ((error: Error) => void)): PathWatcher
-
Parameters
-
event: "error"
-
listener: ((error: Error) => void)
-
- (error: Error): void
-
Returns void
- on(event: "raw", listener: ((eventName: string, path: default, details: any) => void)): PathWatcher
-
Parameters
-
event: "raw"
-
listener: ((eventName: string, path: default, details: any) => void)
-
- (eventName: string, path: default, details: any): void
-
Parameters
-
eventName: string
-
-
details: any
Returns void
- on(event: "unlink" | "unlinkDir", listener: ((path: default) => void)): PathWatcher
-
Parameters
-
event: "unlink" | "unlinkDir"
-
listener: ((path: default) => void)
unwatch
- unwatch(paths: string | default | readonly string[] | readonly default[]): FSWatcher
-
Returns FSWatcher
Wrapper class around chokidar's
FSWatcher. Main notable differences:Pathinstance instead ofstring.addandunwatchmethods also acceptPathinstance(s) in addition to the typical string representations of filepaths.Param
Chokidar options controlling the behavior of the filepath watcher. Note the following differences:
options.ignoreInitialis changed totrueby default.options.cwdis enforced to benull(listeners do not get relative path strings) in order to be compatible with thePathclass.