Class WatchService

A service for using watches.

Index

Constructors

Methods

close make poll update

Constructors

constructor

new WatchService(
serviceConfig: ClientServiceConfig,
watchApis: WatchApis,
): WatchService
Constructs a service object.
Parameters
- serviceConfig: ClientServiceConfig
  Service configuration.
- watchApis: WatchApis
  Watch network APIs implementation.
Returns WatchService
- Defined in src/client/watches/WatchService.ts:29

Methods

close

close(): Promise<void>
Closes any open watches for this watch service.

Returns Promise<void>
- Defined in src/client/watches/WatchService.ts:63

make

make(display: string, ids: Ids, grid?: HGrid): Promise<Watch>
Create a new watch on the specified data.

https://project-haystack.org/doc/Ops#watchSub https://project-haystack.org/doc/Ops#watchUnsub https://project-haystack.org/doc/Ops#watchPoll
Parameters
- display: string
  Display name for the watch.
- ids: Ids
  The ids to watch.
- Optionalgrid: HGrid
  An optional empty grid to use for the watch.
Returns Promise<Watch>
An opened watch.
- Defined in src/client/watches/WatchService.ts:51

poll

poll(): Promise<void>
Request a poll for all opened watches.

Please note, polls are normally handled automatically so manually calling this is not normally required.

Returns Promise<void>
- Defined in src/client/watches/WatchService.ts:95

update

update(
    dicts:
        | HaysonDict
        | HDict
        | HGrid
        | HaysonDict[]
        | HList<HDict>
        | HDict[],
): Promise<void>
Triggers a manual update of the watches.

This is used to manually update dicts outside of a poll. Providing the dicts are newer and they're being watched, any listeners will receive the update as if they were updated from the server via a watch poll request.
Parameters
- dicts: HaysonDict | HDict | HGrid | HaysonDict[] | HList<HDict> | HDict[]
  The dicts to update.
Returns Promise<void>
- Defined in src/client/watches/WatchService.ts:77