Getting Started

Installer

npm install @capgo/capacitor-webview-crash
npx cap sync

Importer

import { WebViewCrash } from '@capgo/capacitor-webview-crash';

Flux de récupération recommandé

Attachez les écouteurs aussi tôt que possible dans le démarrage de votre application afin que le runtime récupéré puisse réagir avant que les utilisateurs continuent à naviguer :

import { WebViewCrash } from '@capgo/capacitor-webview-crash';

await WebViewCrash.addListener('webViewRestoredAfterCrash', async (info) => {
  console.log('Recovered after a WebView crash', info);

  // Rehydrate critical state, reopen the correct screen, or prompt the user to retry.
  await WebViewCrash.clearPendingCrashInfo();
});

await WebViewCrash.addListener('webViewRestoredAfterRestart', async (info) => {
  console.log('Recovered after a native WebView restart', info);
  await WebViewCrash.clearPendingCrashInfo();
});

const pending = await WebViewCrash.getPendingCrashInfo();
// Note: the listener callback may have already cleared the pending marker.
if (pending.value) {
  console.log('Pending crash or restart marker', pending.value);
}

Redémarrage auto natif

Définir les options de redémarrage dans capacitor.config.ts afin que la décision reste dans le code natif même lorsque le runtime JavaScript a crashé ou n'a pas chargé encore :

import type { CapacitorConfig } from '@capacitor/cli';
import type { WebViewCrashPluginConfig } from '@capgo/capacitor-webview-crash';

const webViewCrash: WebViewCrashPluginConfig = {
  // Enabled by default. Keep this on for long-running apps.
  restartOnCrash: true,

  // Use a 5-field cron schedule in the device local timezone.
  // Do not combine restartCron with an active restartIntervalMs.
  restartCron: '0 3 * * *',

  // Optional delay before restarting after a crash.
  restartAfterCrashDelayMs: 0,
};

const config: CapacitorConfig = {
  plugins: {
    WebViewCrash: webViewCrash,
  },
};

export default config;

Utiliser restartIntervalMs pour les applications toujours allumées où les utilisateurs peuvent conserver la même vue Web ouverte pendant des jours : écrans de kiosque, tableaux de bord de contrôle de salle, scanners de entrepôt, terminaux de caisse, tablettes de flotte et affichages numériques. restartCron Utiliser 0 3 * * * pour les redémarrages horloges telles que reason: 'periodicRestart', then Android recreates the host activity and iOS rebuilds the Capacitor bridge view so a new WKWebView , puis Android recrée l'activité de l'hôte et iOS reçoit à nouveau la vue de pont code afin qu'une nouvelle

Choisissez une plage ou un calendrier planifié que votre produit peut tolérer. restartCron supporte *, des listes, des plages et des étapes. N'configurez pas les deux plans à la fois : l'initialisation native provoque une erreur de configuration mortelle lorsque restartCron est défini et restartIntervalMs est supérieur à 0. Un redémarrage crée un runtime JavaScript frais, donc persistez les événements en file d'attente, les données non enregistrées des formulaires et l'état de navigation actuel avant d'utiliser des plans agressifs.

Redémarrage manuel natif

Appelez restartWebView() Lorsque le runtime JavaScript actuel décide que la vue Web native doit être remplacée de manière proactive, par exemple après un flux de travail lourd en mémoire ou avant d'entrer dans une session longue non surveillée :

await WebViewCrash.restartWebView();

La méthode écrit un marqueur en attente avec reason: 'manualRestart', résout l'appel actuel, puis demande à code de créer une nouvelle vue WebView. Android reçoit une nouvelle activité. iOS reçoit une nouvelle vue de pont Capacitor pour créer une nouvelle WKWebView est créée au lieu de recharger la page actuelle.

API : vue d'ensemble

getPendingCrashInfo

Renvoie l'indicateur de panne ou de redémarrage natif stocké, ou null lorsqu'il n'y a rien en attente.

const pending = await WebViewCrash.getPendingCrashInfo();
if (pending.value) {
  console.log(pending.value.platform, pending.value.reason);
}

clearPendingCrashInfo

Supprime l'indicateur stocké après que vos traitements de récupération soient terminés.

await WebViewCrash.clearPendingCrashInfo();

simulateCrashRecovery

Crée un marqueur de crash fictif afin que les équipes QA et de débogage local puissent exercer le chemin de récupération sans faire crasher une WebView réelle.

const simulated = await WebViewCrash.simulateCrashRecovery();
console.log(simulated.value);

restartWebView

Stocke un marqueur de redémarrage manuel et demande à code natif de créer une WebView fraîche.

await WebViewCrash.restartWebView();

Notes de plateforme

• Android stocke les métadonnées de crash à partir de onRenderProcessGoney compris didCrash et rendererPriorityAtExit lorsque la plateforme les fournit.
• iOS stocke les métadonnées de crash à partir de webViewWebContentProcessDidTerminate et ajoute l'état actuel de l'application lorsque disponible.
• Redémarrage manuel et planifié créent une vue WebView fraîche. Android reçoit une nouvelle activité hôte ; iOS reçoit une nouvelle vue de pont Capacitor.
• Redémarrages planifiés utilisent reason: 'periodicRestart'; redémarrages manuels utilisent reason: 'manualRestart'.
• La mise en œuvre web ne détecte pas les crashs de rendu réels. L'implémentation web simule uniquement le comportement avec un stockage local.

Référence de type

PendingCrashInfoResult

export interface PendingCrashInfoResult {
  /**
   * Stored crash or restart metadata, or `null` when no marker is pending.
   */
  value: WebViewCrashInfo | null;
}

WebViewCrashPluginConfig

export interface WebViewCrashPluginConfig {
  /**
   * Restart the WebView from native code when the renderer process dies.
   *
   * @default true
   */
  restartOnCrash?: boolean;

  /**
   * Fixed native interval, in milliseconds, for proactively replacing long-running WebViews.
   *
   * Set to `0` to disable interval restarts. Do not combine an active interval
   * with `restartCron`; native initialization fails fast when both schedules are configured.
   *
   * @default 0
   */
  restartIntervalMs?: number;

  /**
   * Cron schedule for proactively replacing long-running WebViews.
   *
   * Uses standard 5-field cron syntax in the device local timezone:
   * `minute hour day-of-month month day-of-week`.
   *
   * Examples:
   * - `0 3 * * *` restarts every day at 03:00.
   * - `0,30 * * * *` restarts every 30 minutes.
   *
   * Do not combine this with an active `restartIntervalMs`; native initialization
   * fails fast when both schedules are configured.
   */
  restartCron?: string;

  /**
   * Delay, in milliseconds, before restarting after a crash.
   *
   * @default 0
   */
  restartAfterCrashDelayMs?: number;
}

WebViewCrashInfo

export interface WebViewCrashInfo {
  /**
   * Platform that detected and stored the marker.
   */
  platform: WebViewCrashPlatform;

  /**
   * Unix timestamp in milliseconds for when the marker was written.
   */
  timestamp: number;

  /**
   * ISO-8601 version of `timestamp`.
   */
  timestampISO: string;

  /**
   * Platform-specific reason for the crash or restart marker.
   */
  reason: WebViewCrashReason;

  /**
   * Last known WebView URL when the marker was written.
   */
  url?: string;

  /**
   * Android-only hint from `RenderProcessGoneDetail.didCrash()`.
   */
  didCrash?: boolean;

  /**
   * Android-only renderer priority reported at exit.
   */
  rendererPriorityAtExit?: number;

  /**
   * iOS-only application state captured when the WebView process died.
   */
  appState?: WebViewCrashAppState;
}

WebViewCrashPlatform

export type WebViewCrashPlatform = 'android' | 'ios' | 'web';

WebViewCrashReason

export type WebViewCrashReason =
  | 'renderProcessGone'
  | 'webContentProcessDidTerminate'
  | 'periodicRestart'
  | 'manualRestart'
  | 'simulated';

WebViewCrashAppState

export type WebViewCrashAppState = 'active' | 'inactive' | 'background' | 'unknown';

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRexécuter à nouveau la synchronisation lorsque les modifications publiques API se produisent en amont.

Continuez de l'étape de démarrage

Si vous utilisez Getting Started pour planifier le comportement de médias et d'interface natives, connectez-le à Utilisez @capgo/capacitor-webview-crash pour la capacité native dans Utilisez @capgo/capacitor-webview-crash, Utilisez @capgo/capacitor-live-activities pour la capacité native dans Utilisez @capgo/capacitor-live-activities, @capgo/capacitor-live-activities pour le détail d'implémentation dans @capgo/capacitor-live-activities, Utilisez @capgo/capacitor-video-player pour la capacité native dans Utilisez @capgo/capacitor-video-player, et @capgo/capacitor-player vidéo pour les détails d'implémentation dans @capgo/capacitor-player vidéo.