Function worker

  • worker(hostname, endpointKey, token, conditions, interval?, log?): Promise<never>

  • Main worker function of the external endpoint notifier. Runs forevever and never returns. This function is async meaning it needs to be allowed to run when it needs to. So make sure you don't hog up the event loop. (Or run this on a separate thread)

    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 Promise<never>

    I hope not.

    See

    • Condition
    • logFuncs

Settings

Member Visibility