Mulai

Salin prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-live-reload`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/live-reload/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Instal

Anda dapat menggunakan Pengaturan AI yang Dibantu untuk menginstal plugin. Tambahkan kemampuan Capgo ke alat AI Anda 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-live-reload` plugin in my project.

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

bun add @capgo/capacitor-live-reload
bunx cap sync

Import

import { LiveReload } from '@capgo/capacitor-live-reload';

Ringkasan API

`configureServer`

Simpan pengaturan server dev remote yang digunakan untuk koneksi berikutnya.

import { LiveReload } from '@capgo/capacitor-live-reload';

await LiveReload.configureServer({} as ConfigureServerOptions);

`connect`

Establisikan koneksi WebSocket jika tidak ada koneksi aktif yang sedang berjalan.

import { LiveReload } from '@capgo/capacitor-live-reload';

await LiveReload.connect();

`disconnect`

Tutup koneksi WebSocket saat ini dan nonaktifkan auto reconnect.

import { LiveReload } from '@capgo/capacitor-live-reload';

await LiveReload.disconnect();

`getStatus`

Mengembalikan status koneksi saat ini.

import { LiveReload } from '@capgo/capacitor-live-reload';

await LiveReload.getStatus();

`reload`

Trigger reload penuh untuk WebView Capacitor.

import { LiveReload } from '@capgo/capacitor-live-reload';

await LiveReload.reload();

`reloadFile`

Reload file/module tunggal jika runtime mendukung (jatuh kembali ke reload penuh).

import { LiveReload } from '@capgo/capacitor-live-reload';

await LiveReload.reloadFile({} as FileUpdatePayload);

Referensi Tipe

`ConfigureServerOptions`

export interface ConfigureServerOptions {
  /**
   * Base URL for the dev server (e.g. https://dev.local:5173).
   * When a connection is established the Capacitor WebView navigates to this URL.
   */
  url: string;
  /** Optional WebSocket path override when different from /ws. */
  websocketPath?: string;
  /** Extra headers sent when creating the WebSocket connection. */
  headers?: Record<string, string>;
  /** Automatically reconnect when the socket closes unexpectedly. Default: true. */
  autoReconnect?: boolean;
  /** Delay (ms) between reconnection attempts. Default: 2000. */
  reconnectInterval?: number;
}

`LiveReloadStatus`

export interface LiveReloadStatus {
  connected: boolean;
  url?: string;
}

`FileUpdatePayload`

export interface FileUpdatePayload {
  path: string;
  hash?: string;
}

`LiveReloadEventCallback`

export type LiveReloadEventCallback = (event: LiveReloadEventPayload) => void;

`LiveReloadStatusCallback`

export type LiveReloadStatusCallback = (status: LiveReloadStatus) => void;

`LiveReloadEventPayload`

export interface LiveReloadEventPayload {
  type: LiveReloadMessageType;
  /** Populated when type === 'file-update'. */
  file?: FileUpdatePayload;
  /** Optional human-readable message for errors or status changes. */
  message?: string;
}

`LiveReloadMessageType`

export type LiveReloadMessageType = 'full-reload' | 'file-update' | 'error' | 'connected' | 'disconnected';

Sumber Kebenaran

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

Lanjutkan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan dashboard dan API operasi, hubungkannya dengan Menggunakan @capgo/capacitor-live-reload untuk kemampuan asli di Menggunakan @capgo/capacitor-live-reload, API Pengenalan untuk detail implementasi di API Pengenalan Pendahuluan untuk detail implementasi di Pendahuluan API Kunci untuk detail implementasi di API Kunci, dan Perangkat untuk detail implementasi di Perangkat.