Class: Tiga

tiga.launch(options)

启动 SDK 并创建一个 App 实例。

options.proxy 参数非空时,SDK 会启动本地代理服务,小程序环境需要手动修改开发者工具的代理端口:【开发者工具】-【设置】-【代理设置】-【手动设置代理】。如果选择开启 Https 拦截,SDK 会自动校验证书是否安装,若未安装则会引导安装证书,详细请参考 AnyProxy 证书配置指南

  • Since: 0.6.0

  • Arguments:

    • options <object> 启动配置选项。
      • env <string> 启动环境,合法值为 'web'(浏览器) 或 'wxapp'(微信小程序)。
      • timeout? <number> 启动浏览器/小程序开发者工具的最长等待时间。(Default: 30000)
      • web? <object> 浏览器环境的配置选项。
        • headless <boolean> 是否开启无头模式,如果 devtools 选项为 true,则该值会被置为 false。(Default: true)
        • executablePath <string> 可运行 Chromium 或 Chrome 可执行文件的路径。
        • devtools <boolean> 是否自动打开 DevTools 面板,如果该选项为 true,则 headless 选项会被置为 false。(Default: false)
      • wxapp? <object> 微信小程序环境的配置选项。
        • cliPath <string> 开发者工具命令行工具绝对路径。
        • projectPath <string> 项目绝对路径。
        • projectConfig <object> 项目配置,详见 小程序项目配置文件
      • proxy? <object|boolean> 本地代理服务的配置选项。
        • port <number> 代理服务端口。(Default: 8880)
        • throttle <number> 限速值,单位 kb/s。(Default: 不限速)
        • https <boolean> 是否开启 Https 拦截,开启后会自动校验证书。(Default: true)
        • ws <boolean> 是否开启 WebSocket 拦截。(Default: true)
        • ui <object|boolean> 是否启动 web 控制台。
          • port <number> web 控制台端口。(Default: 8885)
      • audits? <boolean> 是否启动审计评分能力。(Default: false)

注意: options.proxy 会启动一个本地代理服务,在小程序端需要手动把工具的代理端口设为服务的端口;

  • Returns: <Promise<App>>

  • Example:

    tiga.launch({
    env: 'web', // 浏览器环境
    })
    .then(async app => {})
    .catch(() => {})
    tiga.launch({
    env: 'wxapp', // 小程序环境
    proxy: true, // 启动代理服务
    wxapp: {
    projectPath: '/path/to/wxapp/project'
    }
    })
    .then(async app => {})
    .catch(() => {})

tiga.env()

获取 SDK 的当前运行环境。

  • Since: 0.6.0

  • Returns: <string> 返回 'web'(浏览器环境) / 'wxapp'(微信小程序环境)

  • Example:

    if (tiga.env() === 'web') {
    await app.goto('http://page/b')
    }
    if (tiga.env() === 'wxapp') {
    await app.goto('/page/b')
    }

tiga.template(name?)

获取模板实例。

  • Since: 1.2.0

  • Arguments:

    • name? <string> 模板名,若为空则返回默认模版
  • Returns: <Template>

  • Example:

    tiga.template('http-mock')
    .config({ ... })
    .exec()