Démarrage

Installer

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

Importer

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

API Aperçu

configureServer

Stocker les paramètres du serveur de développement distant utilisés pour les connexions ultérieures.

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

await LiveReload.configureServer({} as ConfigureServerOptions);

connect

Establisher une connexion WebSocket si une connexion n'est pas déjà active.

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

await LiveReload.connect();

disconnect

Fermer la connexion WebSocket actuelle et désactiver la reconnexion automatique.

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

await LiveReload.disconnect();

getStatus

Renvoie le statut de connexion actuel.

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

await LiveReload.getStatus();

reload

Déclenche un rechargement complet de la vue Capacitor.

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

await LiveReload.reload();

reloadFile

Recharge un seul fichier/module si le runtime le supporte (retourne à un rechargement complet).

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

await LiveReload.reloadFile({} as FileUpdatePayload);

Référence de type

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

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-faire la synchronisation lorsque le public API change en amont.

Continuer depuis Getting Started

Si vous utilisez Getting Started pour planifier le tableau de bord et les API opérations, connectez-le avec En utilisant @capgo/capacitor-live-reload pour la capacité native en utilisant @capgo/capacitor-live-reload, API Vue d'ensemble pour le détail d'implémentation dans API Vue d'ensemble, Introduction pour le détail d'implémentation dans Introduction, API Clés pour le détail d'implémentation dans API Clés, et Appareils pour le détail d'implémentation dans Appareils.