Getting Started

安装

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

导入

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

API 概述

configureServer

用于后续连接的远程开发服务器设置

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

await LiveReload.configureServer({} as ConfigureServerOptions);

connect

如果没有活动的 WebSocket 连接，则建立一个 WebSocket 连接

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

await LiveReload.connect();

disconnect

复制到剪贴板

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.ts. 当上游的公共 API 变更时，请重新同步

继续从 Getting Started

如果您正在使用 Getting Started 来规划仪表板和 API 操作，请将其连接到 使用 @capgo/capacitor-live-reload 用于在 Using @capgo/capacitor-live-reload 中实现的本机功能 API Overview 用于在 API Overview 中实现的详细信息 介绍 在介绍中实现细节 API 键 在 API 键中实现细节 设备 在设备中实现细节