Einstieg

Eine Einrichtungsprompt mit den Installationsanweisungen und der vollständigen Markdown-Dokumentation für diesen Plugin kopieren.

        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.

Installieren

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

Importieren

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

API Übersicht

`configureServer`

Speichern Sie die Einstellungen für den Remote-Entwicklungs-Server für zukünftige Verbindungen.

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

await LiveReload.configureServer({} as ConfigureServerOptions);

`connect`

Wenn keine aktive WebSocket-Verbindung besteht, eine neue herstellen.

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

await LiveReload.connect();

`disconnect`

Schließen Sie die aktuelle WebSocket-Verbindung und deaktivieren Sie die automatische Wiederherstellung.

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

await LiveReload.disconnect();

`getStatus`

Gibt den aktuellen Verbindungszustand zurück.

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

await LiveReload.getStatus();

`reload`

Auslösen eines vollständigen Neuladens des Capacitor WebView.

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

await LiveReload.reload();

`reloadFile`

Laden Sie ein einzelnes Datei/Modul neu, wenn die Laufzeit unterstützt es (fällt zurück auf vollständiges Neuladen).

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

await LiveReload.reloadFile({} as FileUpdatePayload);

Typenverweis

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.