はじめに

Install

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

Import

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

API オーバービュー

configureServer

接続先の開発サーバー設定を保存します。

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

await LiveReload.configureServer({} as ConfigureServerOptions);

connect

既存の接続がなければWebSocket接続を確立します。

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

await LiveReload.connect();

disconnect

現在のWebSocket接続を閉じ、自動再接続を無効化します。

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

await LiveReload.disconnect();

getStatus

現在の接続状態を取得します。

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

await LiveReload.getStatus();

reload

Capacitor WebViewを完全に再読み込みします。

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

await LiveReload.reload();

reloadFile

ファイルの再読み込み (サポートされている場合、全体の再読み込みにフォールバックします)

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

await LiveReload.reloadFile({} as FileUpdatePayload);

型参照

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

真実の源

このページはプラグインの src/definitions.tsAPIがアップストリームで変更された場合に、パブリックを再度同步してください。

Getting Startedから続けてください

あなたは「を使用しています Getting Started APIとダッシュボードの計画、APIの操作を接続する場合 capgo/capacitor-live-reloadを使用する capgo/capacitor-live-reloadのネイティブ機能の使用 APIの概要 APIの実装詳細 Introduction 実装詳細 API Keys APIの実装詳細 デバイス デバイスの実装詳細について