Function start

  • start(hostname, endpointKey, token, conditions, interval?, log?): void

  • Calls worker() with the parameters provided and adds an error handler just in case something happens (for debug purposes).

    Parameters

    • hostname: string

      Hostname of the Gatus webserver. Without http(s) prefix.

    • endpointKey: string

      Endpoint key for the external endpoint you are targetting.

    • token: string

      Bearer token configured in Gatus for the external endpoint.

    • conditions: Condition[]

      List of steps for each health check. Every condition is guaranteed to run in order and will be awaited.

    • interval: number = ...

      Roughly how often the health check should run. Do keep in mind that the single-threaded nature of JavaScript might make this difficult if you don't know how to program with async.

    • log: LogFunc = logFuncs.consoleLog

      Logging function.

    Returns void

Settings

Member Visibility