GeoLeaf Core API - v3.0.0
    Preparing search index...
    OfflineDetector: {
        init(options?: Partial<OfflineDetectorConfig>): void;
        destroy(): void;
        checkConnectivity(): Promise<boolean>;
        stopPeriodicCheck(): void;
        isOnline(): boolean;
    } = ...

    Type Declaration

    • init: function
      • 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
    • checkConnectivity: function
      • Checks real connectivity (with a ping when configured)

        Returns Promise<boolean>

        const isOnline = await GeoLeaf.Storage.OfflineDetector.checkConnectivity();
        
    • stopPeriodicCheck: function
    • isOnline: function
      • Returns the État de connexion current

        Returns boolean

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