Mulai Menggunakan

Instalasi

Kamu bisa menggunakan Setup Bantuan AI untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI kamu menggunakan perintah berikut:

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

Lalu gunakan prompt berikut:

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

Jika kamu lebih suka Setup Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

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

Import

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

Alur pemulihan yang direkomendasikan

Tetapkan pendengar sebagai awal mungkin dalam proses startup aplikasi Anda agar runtime yang dipulihkan dapat bereaksi sebelum pengguna melanjutkan navigasi:

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

Mulai ulang otomatis native

Atur opsi restart di capacitor.config.ts sehingga keputusan tetap berada di native code bahkan ketika runtime JavaScript telah mengalami crash atau belum terisi:

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;

Gunakan restartIntervalMs untuk aplikasi selalu aktif di mana pengguna mungkin membuka WebView yang sama selama hari-hari: layar kiosk, dashboard ruang kontrol, scanner gudang, terminal kasir, tablet armada, dan tanda digital. restartCron untuk restart jam dinding seperti 0 3 * * * untuk restart harian pada pukul 03:00 dalam zona waktu lokal perangkat. Restart yang dijadwalkan menulis marker yang menunggu dengan reason: 'periodicRestart'lalu Android merekreas aktivitas host dan iOS membangun ulang jendela bridge Capacitor sehingga Capacitor baru WKWebView dibuat dari native code.

Pilih interval atau jadwal cron yang produk Anda dapat menolerir. restartCron menggunakan *daftar, rentang, dan langkah. Jangan konfigurasi kedua jadwal sekaligus: inisialisasi native mengeluarkan kesalahan konfigurasi fatal ketika restartCron diatur dan restartIntervalMs lebih besar dari 0. Restart membuat runtime JavaScript yang segar, jadi simpan event yang antri, keadaan formulir yang belum disimpan, dan keadaan navigasi saat ini sebelum menggunakan jadwal agresif.

Restart native manual

Panggilan restartWebView() ketika runtime JavaScript saat ini memutuskan bahwa WebView Native harus diganti secara proaktif, misalnya setelah aliran kerja berat memori atau sebelum memasuki sesi tidak terduga yang panjang:

await WebViewCrash.restartWebView();

Methode menulis marker yang menunggu dengan reason: 'manualRestart'mengatasi panggilan saat ini, kemudian bertanya kepada native code untuk membuat WebView yang segar. Android merekreasi aktivitas host. iOS membangun kembali jembatan Capacitor view sehingga halaman baru WKWebView dibuat daripada memuat ulang halaman saat ini.

API Ringkasan

getPendingCrashInfo

Mengembalikan marker kecelakaan atau restart native yang disimpan, atau null ketika tidak ada yang menunggu.

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

clearPendingCrashInfo

Menghapus marker yang disimpan setelah proses pemulihan selesai.

await WebViewCrash.clearPendingCrashInfo();

simulateCrashRecovery

Membuat marker kecelakaan palsu sehingga QA dan debugging lokal dapat menguji jalur pemulihan tanpa membuat WebView nyata mengalami kecelakaan.

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

restartWebView

Menyimpan marker restart manual dan meminta native code untuk membuat WebView baru.

await WebViewCrash.restartWebView();

Catatan platform

• Android menyimpan metadata kecelakaan dari onRenderProcessGone, termasuk didCrash dan rendererPriorityAtExit ketika platform menyediakannya.
• iOS menyimpan metadata kecelakaan dari webViewWebContentProcessDidTerminate dan menambahkan kondisi aplikasi saat ini ketika tersedia.
• Restart manual dan yang dijadwalkan membuat WebView yang segar. Android merekreasikan aktivitas host; iOS membangun ulang jendela bridge Capacitor.
• Restart yang dijadwalkan menggunakan reason: 'periodicRestart'; restart manual menggunakan reason: 'manualRestart'.
• Webview tidak mendeteksi kecelakaan renderer yang sebenarnya. Implementasi web hanya meniru perilaku dengan menggunakan penyimpanan lokal.

Referensi Tipe

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

Sumber Kebenaran

Halaman ini dihasilkan dari plugin’s src/definitions.ts. Re-run sinkronisasi ketika publik API berubah di atas

Teruskan dari Getting Started

Jika Anda menggunakan Mulai Menggunakan untuk merencanakan perilaku media asli dan antarmuka, hubungkannya dengan Menggunakan @capgo/capacitor-webview-crash untuk kemampuan asli dalam Menggunakan @capgo/capacitor-webview-crash, Menggunakan @capgo/capacitor-live-activities untuk kemampuan asli dalam Menggunakan @capgo/capacitor-aktivitas-nyata, @capgo/capacitor-aktivitas-nyata untuk detail implementasi dalam @capgo/capacitor-aktivitas-nyata, Menggunakan @capgo/capacitor-pemain-video untuk kemampuan asli dalam Menggunakan @capgo/capacitor-pemain-video, dan @capgo/capacitor-pemain-video untuk detail implementasi dalam @capgo/capacitor-pemain-video.