小程序使用说明

@huolala-tech/page-spy-wechat

该 SDK 为微信小程序专属 SDK，其他平台小程序可使用 UniApp SDK

接入

1. 安装：

npm install @huolala-tech/page-spy-wechat
// or
yarn add @huolala-tech/page-spy-wechat

2. 域名白名单

将 page-spy 服务域名填入小程序的 http、websocket 请求白名单中。注意除了开发环境，小程序强制要求使用 https 和 wss 协议。

https://your.pagespy.domain

wss://your.pagespy.domain

3. 在入口文件中引入 SDK 并实例化：

import PageSpy from '@huolala-tech/page-spy-wechat';
new PageSpy({
  api: 'your.pagespy.domain',
  // 小程序默认使用 https 和 wss 协议，你可以通过下面的配置来关闭这一行为。 
  // enableSSL: false
})

原生微信小程序使用 npm 包请参考微信小程序文档 在微信小程序中使用 npm

配置参数

const pageSpy = new PageSpy(config?: InitConfig)

interface InitConfig {
  // server 地址域名，必填。
  // 例子："your.pagespy.domain"
  api: string;

  // project 作为信息的一种聚合，可以在调试端房间列表进行搜索
  // 默认值 'default'
  project?: string;

  // title 供用户提供自定义参数，可以用于区分当前调试的客户端
  // 对应的信息显示在每个调试连接面板的「设备id」下方
  // 默认值 '--'
  title?: string;

  // 手动指定 PageSpy 服务的 scheme。
  // 注意小程序除了开发环境外，强制要求使用 https 和 wss 协议，所以：
  //  - （默认）传值 undefined 或者 null：自动转换为 TRUE;
  //  - true：SDK 将通过 ["https://", "wss://"] 访问 PageSpy 服务;
  //  - false：SDK 将通过 ["http://", "ws://"] 访问 PageSpy 服务;
  enableSSL?: boolean | null;

  // 在 release 环境禁用。
  //  - true (Default)：默认仅允许 PageSpy 在开发版 ("develop") 和体验版 ("trial") 使用
  //  - false：允许正式版里开启
  disabledOnProd?: boolean;
}

常见问题

小程序报错：Cannot set property request of # which has only a getter

微信小程序 仅支持基础包版本 2.14 及以上。