Class ZFileWatch

constructor

• new ZFileWatch(path: string): ZFileWatch

  Initializes a new instance of this object.

  Parameters

  • path: string

    The path to watch.

  Returns ZFileWatch

Readonlypath

add

• add(): Observable<IZFileSystemNode>

  The stream for files being added.

  This can only occur if the target being watched is a folder.

  Returns Observable<IZFileSystemNode>

  The observable that will publish files that get added.

remove

• remove(): Observable<IZFileSystemNode>

  The stream for files and folders being deleted.

  If this watcher points to a folder, then all files under the folder will be sent through this observable, including the folder being watched. If this points to a file, then this will only receive when the file is unlinked.

  Returns Observable<IZFileSystemNode>

  The observable that will publish file and folders that are unlinked and removed respectively. Note that files and folders streamed this way will not have their stats set.

start

• start(): Promise<void>

  Starts the watch operation.

  Returns Promise<void>

stop

• stop(): Promise<void>

  Stops the watch operation.

  Returns Promise<void>

update

• update(): Observable<IZFileSystemNode>

  The stream for files being updated.

  If this watcher points to a folder, then all files recursively will send when they get updated. If this watcher points to a file, then this will only invoke when the file is updated.

  Returns Observable<IZFileSystemNode>

  The observable that will publish files and folders that are updated.