README_ZH.md

English | 中文

@huolala-tech/page-spy-uniapp

这个 SDK 用于调试 UniAPP 开发的小程序.

Caution

小程序提交审核时请务必删除代码中的 SDK，否则会导致审核失败。

使用

import PageSpy from '@huolala-tech/page-spy-uniapp'

const pageSpy = new PageSpy(config?: InitConfig)

InitConfig 定义

除了 api 参数是必须明确指定，其他参数都是可选的：

const pageSpy = new PageSpy(config?: InitConfig)

interface InitConfig {
  // server 地址域名，必填。
  // 例子："example.com"
  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;

  // PageSpy 所有内置插件默认开启，可以按需禁用指定插件。
  disabledPlugins?: (InternalPlugins | string)[];

  // 某些小程序平台例如 mPaaS，钉钉以及老版本的支付宝小程序，他们只支持全局单个 socket 连接，而且由于某些原因我们无法用代码
  // 区分出这些平台，所以我们提供了这个配置项来让你决定。
  // 如果你在开发 mPaaS，钉钉或者其他阿里系小程序，遇到了连接问题，可以将该配置项设为 true。
  singletonSocket?: boolean;
}

type InternalPlugins =
  | 'ConsolePlugin'
  | 'ErrorPlugin'
  | 'NetworkPlugin'
  | 'StoragePlugin'
  | 'SystemPlugin';

小程序更详细的说明请阅读 小程序使用说明。