Iniciación

Instalar

Puede utilizar nuestra configuración asistida por inteligencia artificial para instalar el complemento. Agregue las Capgo habilidades a su herramienta de inteligencia artificial utilizando el siguiente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Luego utilice el siguiente prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-webview-crash` plugin in my project.

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siguiendo las instrucciones específicas de la plataforma a continuación:

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

Importar

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

Flujo de recuperación recomendado

Asocie los listeners lo antes posible en el arranque de tu aplicación para que el runtime recuperado pueda reaccionar antes de que los usuarios continúen navegando:

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);
}

Reinicio automático nativo

Establece opciones de reinicio en capacitor.config.ts para que la decisión permanezca en nativo code incluso cuando el runtime de JavaScript se ha caído o no se ha cargado aún:

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;

Usa restartIntervalMs para aplicaciones siempre encendidas donde los usuarios pueden mantener la misma WebView abierta durante días: pantallas de kiosk, tableros de control, escáneres de almacén, terminales de caja, tabletas de flota y señalización digital. restartCron para reinicios del reloj de pared como 0 3 * * * para un reinicio diario a las 03:00 en la zona horaria local del dispositivo. Los reinicios programados escriben un marcador pendiente con reason: 'periodicRestart', luego Android recrea la actividad del host y iOS reconstruye la vista del puente Capacitor para crear un nuevo WKWebView se crea desde el code nativo.

Elige un intervalo o un horario cron que tu producto pueda tolerar. restartCron admite *, listas, rangos y pasos. No configures ambos horarios al mismo tiempo: la inicialización nativa lanza un error de configuración fatal cuando restartCron está configurado y restartIntervalMs es mayor que 0. Un reinicio crea un entorno de tiempo de ejecución JavaScript fresco, por lo que persiste los eventos programados, el estado de formulario no guardado y el estado de navegación actual antes de usar horarios agresivos.

Reinicio nativo manual

Llamar restartWebView() cuando el tiempo de ejecución de JavaScript actual decide que el navegador nativo debe ser reemplazado de manera proactiva, por ejemplo después de un flujo de trabajo pesado en memoria o antes de entrar en una sesión larga no atendida:

await WebViewCrash.restartWebView();

El método escribe un marcador pendiente con reason: 'manualRestart', resolves the current call, then asks native code to create a fresh WebView. Android recreates the host activity. iOS rebuilds the Capacitor bridge view so a new WKWebView Android recrea la actividad de host. iOS reconstruye el puente de vista __CAPGO_KEEP_1__ para crear una nueva

API overview

getPendingCrashInfo

Sección titulada “getPendingCrashInfo” null Devuelve el marcador de crash o reinicio nativo almacenado, o

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

clearPendingCrashInfo

Elimina el marcador almacenado después de que se haya completado el manejo de recuperación.

await WebViewCrash.clearPendingCrashInfo();

simulateCrashRecovery

Crea un marcador de crash falso para que QA y depuración local puedan ejercer el camino de recuperación sin hacer que un WebView real se estrelle.

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

restartWebView

Almacena un marcador de reinicio manual y pide a code nativo que cree un WebView fresco.

await WebViewCrash.restartWebView();

Notas de plataforma

• Android almacena metadatos de crash onRenderProcessGoney didCrash y rendererPriorityAtExit cuando la plataforma los proporciona.
• los metadatos de la aplicación de iOS se almacenan desde webViewWebContentProcessDidTerminate y agrega el estado de la aplicación actual cuando esté disponible.
• Los reinicios manuales y programados crean una WebView fresca. Android recrea la actividad del host; iOS reconstruye la vista del puente Capacitor.
• Los reinicios programados utilizan reason: 'periodicRestart'; los reinicios manuales utilizan reason: 'manualRestart'.
• La implementación web no detecta los crash de renderizadores reales. La implementación web solo simula el comportamiento con almacenamiento local.

Referencia de tipos

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';

Fuente de Verdad

Esta página se genera desde el plugin’s src/definitions.ts. Vuelva a ejecutar la sincronización cuando el público API cambie en la fuente.

Siga adelante desde Getting Started

Si está utilizando Getting Started para planificar el comportamiento de medios nativos e interfaces, conecte con Usando @capgo/capacitor-webview-crash para la capacidad nativa en Usando @capgo/capacitor-webview-crash, Usando @capgo/capacitor-live-activities para la capacidad nativa en Usando @capgo/capacitor-live-activities, @capgo/capacitor-actividades-en-vivo para el detalle de implementación en @capgo/capacitor-actividades-en-vivo Usando @capgo/capacitor-reproductor-de-videos para la capacidad nativa en Usando @capgo/capacitor-reproductor-de-videos, y @capgo/capacitor-reproductor-de-videos para el detalle de implementación en @capgo/capacitor-reproductor-de-videos.