Skip to main content
Version: 1.x

Watcher

Constructors​

Constructor​

new Watcher(cwd, options?): Watcher

Parameters​

ParameterType

cwd

string

options?

Options

Returns​

Watcher

Methods​

close()​

close(): Promise<void>

Returns​

Promise<void>


createSubscription()​

createSubscription(): object

Returns​

object

NameType

unsubscribe()

() => Promise<void>


ignore()​

ignore(pattern): void

Parameters​

ParameterType

pattern

MatchPattern

Returns​

void


off()​

off(event, listener): void

Parameters​

ParameterType

event

EventType

listener

WatcherListener

Returns​

void


on()​

on(event, listener): void

Parameters​

ParameterType

event

EventType

listener

WatcherListener

Returns​

void


onEvents()​

onEvents(err, events): void

Parameters​

ParameterType

err

null | Error

events

Event[]

Returns​

void


unignore()​

unignore(pattern): void

Parameters​

ParameterType

pattern

MatchPattern

Returns​

void