Getting Started

Installieren

bun add @capgo/capacitor-webview-guardian
bunx cap sync

Importieren

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

API Übersicht

startMonitoring

Überwacht Hintergrundereignisse und überprüft automatisch die WebView-Gesundheit.

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

await WebviewGuardian.startMonitoring();

stopMonitoring

Beendet jede automatische Hintergrundüberwachung.

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

await WebviewGuardian.stopMonitoring();

getState

Gibt den neuesten bekannten Überwachungsstatus zurück.

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

await WebviewGuardian.getState();

checkNow

Ermöglicht eine sofortige WebView-Gesundheitsprüfung.

import { WebviewGuardian } from '@capgo/capacitor-webview-guardian';

await WebviewGuardian.checkNow();

Typenverweis

StartMonitoringOptions

export interface StartMonitoringOptions {
  /**
   * Delay (in ms) before running a health check after the app re-enters the foreground.
   * Defaults to 600ms to let the bridge finish resuming.
   */
  foregroundDebounceMs?: number;

  /**
   * Script executed via `evaluateJavascript`/`evaluateJavaScript` to confirm the WebView is alive.
   * Defaults to `document.readyState`.
   */
  pingScript?: string;

  /**
   * Automatically reloads the WebView when a terminated render process is detected.
   * Disable to receive `webviewCrashed` events and restart manually.
   */
  autoRestart?: boolean;

  /**
   * Strategy used when restarting the WebView. Defaults to `reload`.
   */
  restartStrategy?: RestartStrategy;

  /**
   * Custom HTTPS/HTTP URL to load when `restartStrategy` is `customUrl`.
   */
  customRestartUrl?: string;

  /**
   * Emits verbose logging in the native layer when true.
   */
  debug?: boolean;

  /**
   * Whether an immediate health check should be executed right after enabling monitoring.
   * Defaults to `true`.
   */
  runInitialCheck?: boolean;
}

GuardianState

export interface GuardianState {
  monitoring: boolean;
  reason: string;
  timestamp: string;
  lastHealthyAt?: string;
  lastRestartAt?: string;
  lastCrashAt?: string;
  pendingRestartReason?: string;
  error?: string;
}

CheckNowOptions

export interface CheckNowOptions {
  /**
   * Text tag describing why a manual check is being requested.
   */
  reason?: string;
}

CheckResult

export interface CheckResult {
  healthy: boolean;
  restarted: boolean;
  reason: string;
  timestamp: string;
  error?: string;
  pendingRestart?: boolean;
}

GuardianEvent

export type GuardianEvent = GuardianState;

RestartStrategy

export type RestartStrategy = 'reload' | 'reloadFromOrigin' | 'customUrl';

Quelle der Wahrheit

Diese Seite wurde von dem Plugin generiert. src/definitions.ts. Wenn sich die öffentliche API im Quellcode ändert, führen Sie die Synchronisierung erneut durch.

Weitermachen von Getting Started

Wenn Sie Cloudflare verwenden Zum Starten um native Medien und Schnittstellenverhalten zu planen und es mit Mit @capgo/capacitor-webview-guardian verwenden Für die native Fähigkeit in Mit @capgo/capacitor-webview-guardian, Mit @capgo/capacitor-live-activities verwenden Für die native Fähigkeit in Mit @capgo/capacitor-live-activities, @capgo/capacitor-live-activities Für die Implementierungsdetails in @capgo/capacitor-live-activities, Mit @capgo/capacitor-video-player verwenden Für die native Fähigkeit in Mit @capgo/capacitor-video-player, und @capgo/capacitor-video-player Für die Implementierungsdetails in @capgo/capacitor-video-player.