Class WatcherClient

constructor

• new WatcherClient(options: IWatcherClientOptions): WatcherClient

  Parameters

  • options: IWatcherClientOptions

  Returns WatcherClient

Alerts

Decisions

Readonlyscenarios

deleteWatcher

• deleteWatcher(): Promise<void>

  Delete the current watcher from the LAPI. Useful to cleanup an auto-registered watcher.

  Returns Promise<void>

login

• login(): Promise<void>

  Returns Promise<void>

registerWatcher

• registerWatcher(options: APITypes.WatcherRegistrationRequest): Promise<null>

  Allow to register a watcher on CLAPI you need to validate on the local machine

  Parameters

  • options: APITypes.WatcherRegistrationRequest

  Returns Promise<null>

stop

• stop(): Promise<void>

  stop the current client, and running processes

  Returns Promise<void>

testConnection

• testConnection(): Promise<void>

  Returns Promise<void>

StaticdeleteWatcher

• deleteWatcher(
      options: APITypes.WatcherRegistrationRequest & IHTTPOptions,
  ): Promise<void>

  Delete a watcher from the LAPI using its credentials. Useful to cleanup an auto-registered watcher without keeping a client instance.

  Parameters

  • options: APITypes.WatcherRegistrationRequest & IHTTPOptions

    the machine credentials + connection options

  Returns Promise<void>

StaticregisterWatcher

• registerWatcher(
      options: APITypes.WatcherRegistrationRequest & IHTTPOptions,
  ): Promise<null>

  Parameters

  • options: APITypes.WatcherRegistrationRequest & IHTTPOptions

  Returns Promise<null>