Class GetStateService

constructor

• new GetStateService(config, logger): GetStateService

• Initialize a new GetStateService.

  Parameters

  • config: IGetStateServiceConfig

    Service configuration.
  • logger: ILogger

    Service logger.

  Returns GetStateService

_endpoint

_method

data

autoUpdate

• autoUpdate(): void

• Recursive wrapper for the polling mechanism. The next request/interval starts after the preceding one has ended. That means a big timeout (IGetStateServiceConfig.timeout) could cause an actual higher update interval (IGetStateServiceConfig.updateInterval).

  Returns void

getData

• getData(): AxiosPromise<string>

• Stage request and return the corresponding AxiosPromise.

  Returns AxiosPromise<string>

getUpdateInterval

• getUpdateInterval(): number

• Get the update interval [ms].

  Returns number

hasData

• hasData(): boolean

• Tells you whether the service has most recent status information or not.

  More accurately it tells you whether the most recent request succeeded or not. So it will return true if the request succeeded and your data is up-to-date. It will return false until the service retrieved its first data and again if a subsequent request fails.

  Returns boolean

isRunning

• isRunning(): boolean

• Check whether the service is running.

  Returns boolean

setUpdateInterval

• setUpdateInterval(milliseconds): void

• Set the update interval.

  Parameters

  • milliseconds: number

    Update interval in milliseconds [ms].

  Returns void

start

• start(successCallback?, errorCallback?, stopOnError?): void

• Start the service.

  This will periodically update the internal data and invoke the optional callables each time new data is received.

  Parameters

  • OptionalsuccessCallback: ((data: GetStateData) => void)

    Will be triggered everytime the service receives new data. The current GetStateData object is passed as parameter to the callback.

    • • (data): void

      • Parameters

        • data: GetStateData

        Returns void

  • OptionalerrorCallback: ((e: Error) => void)

    Error callback receives the most recent error as parameter, in case the consecutive error tolerance is hit.

    • • (e): void

      • Parameters

        • e: Error

        Returns void

  • OptionalstopOnError: boolean

    Whether to stop in case the consecutive error tolerance is hit. Default behavior (for backward compatibility) is to keep running in any case.

  Returns void

stop

• stop(): void

• Stop the service.

  Returns void

update

• update(): Promise<GetStateData>

• Update data by staging an HTTP request to the pool controller.

  This method will be triggered periodically once the service has been started (see GetStateService.start). It also includes the part responsible for the execution of the [[_updateCallback]] (see start).

  Returns Promise<GetStateData>