Variable OfflineDetectorConst

Type Declaration

• init: function

  • init(options?: Partial<OfflineDetectorConfig>): void

    Initializes the detector.

    Idempotent: a second call tears the previous one down first, so listeners and timers are never registered twice.

    Parameters

    • options: Partial<OfflineDetectorConfig> = {}

      Configuration options

      • showBadge

        Show the UI badge

      • badgePosition

        Badge position (top-right, top-left, etc.)

      • checkInterval

        Check interval in ms

      • pingUrl

        URL used for the connectivity ping

    Returns void

• destroy: function

  • destroy(): void

    Detaches event listeners, clears timers and removes the badge.

    Returns void

• checkConnectivity: function

  • checkConnectivity(): Promise<boolean>

    Checks real connectivity (with a ping when configured)

    Returns Promise<boolean>

    Example

    const isOnline = await GeoLeaf?.Storage?.OfflineDetector?.checkConnectivity?.();
    Copy

• stopPeriodicCheck: function

  • stopPeriodicCheck(): void

    Stops the periodic check

    Returns void

• isOnline: function

  • isOnline(): boolean

    Returns the current connection state

    Returns boolean

    Example

    if (GeoLeaf?.Storage?.OfflineDetector?.isOnline()) {
      // Perform a network request
    }
    Copy