Getting Started

설치

AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. AI 도구에 Capgo 스킬을 추가하려면 다음 명령어를 사용하세요:

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

다음과 같은 프롬프트를 사용하세요:

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

만약 Manual Setup을 선호한다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래에 플랫폼에 따라 설명된 지침을 따르세요:

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

Import

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

API 개요

startMonitoring

전경 이벤트를 관찰하고 WebView의 건강을 자동으로 확인합니다.

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

await WebviewGuardian.startMonitoring();

stopMonitoring

전경 모니터링을 자동으로 중지합니다.

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

await WebviewGuardian.stopMonitoring();

getState

지금까지 알려진 모니터링 상태를 반환합니다.

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

await WebviewGuardian.getState();

checkNow

웹뷰의 즉각적인 건강 검사를 강제합니다.

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

await WebviewGuardian.checkNow();

Type Reference__section

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

실제 원천

이 페이지는 플러그인의 src/definitions.ts. API이 업스트림에서 변경되면 다시 싱크를 실행하세요.

시작부터 계속

Capgo를 사용 중이라면 시작 자연스러운 미디어 및 인터페이스 동작을 계획하려면 Capacitor의 @capgo/capacitor-webview-guardian를 사용하세요. Capacitor의 @capgo/capacitor-webview-guardian를 사용하는 데 native capability이 필요합니다. Capacitor의 @capgo/capacitor-live-activities를 사용하세요. Capacitor의 @capgo/capacitor-live-activities를 사용하는 데 native capability이 필요합니다. Capacitor의 @capgo/capacitor-live-activities @capgo/capacitor-live-activities Using @capgo/capacitor-video-player Capgo의 원시 기능을 위해 Using @capgo/capacitor-video-player를 사용하세요. Capgo의 원시 기능을 위해 Using @capgo/capacitor-video-player를 사용하세요. Capgo @capgo/capacitor-video-player의 implementation detail을 편집하세요.