craft-hub / ProjectWatcher

Class: ProjectWatcher

Defined in: packages/craft-hub/src/watcher.ts:60

Watch registered projects and emit coalesced semantic change events.

Constructors

Constructor

new ProjectWatcher(listener, debounceMs?): ProjectWatcher

Defined in: packages/craft-hub/src/watcher.ts:65

Parameters

listener

ProjectChangeListener

debounceMs?

number = 200

Returns

ProjectWatcher

Methods

close()

close(): Promise<void>

Defined in: packages/craft-hub/src/watcher.ts:103

Stop every watcher and discard pending events.

Returns

Promise<void>

---

unwatch()

unwatch(projectId): Promise<void>

Defined in: packages/craft-hub/src/watcher.ts:113

Stop watching one registered project.

Parameters

projectId

string

Returns

Promise<void>

---

watch()

watch(project): Promise<void>

Defined in: packages/craft-hub/src/watcher.ts:71

Begin watching a project. Repeated calls for the same project are ignored.

Parameters

project

ProjectRecord

Returns

Promise<void>