MiniProgram

MiniProgram 模块提供了控制小程序的方法。

方法

miniProgram.pageStack

获取小程序页面堆栈。

miniProgram.pageStack(): Promise<Page[]>

示例代码：

automator.launch().then(async miniProgram => {
  const pageStack = await miniProgram.pageStack()
  console.log(pageStack.length) // 当前页面栈数量
})

miniProgram.navigateTo

保留当前页面，跳转到应用内的某个页面，同 wx.navigateTo。

miniProgram.navigateTo(url: string): Promise<Page>

参数说明

示例代码：

automator.launch().then(async miniProgram => {
  const page = await miniProgram.navigateTo('/page/component/index')
  console.log(page.path) // -> 'page/component/index'
})

miniProgram.redirectTo

关闭当前页面，跳转到应用内的某个页面，同 wx.redirectTo。

miniProgram.redirectTo(url: string): Promise<Page>

参数说明

miniProgram.navigateBack

关闭当前页面，返回上一页面或多级页面，同 wx.navigateBack。

miniProgram.navigateBack(): Promise<Page>

miniProgram.reLaunch

关闭所有页面，打开到应用内的某个页面，同 wx.reLaunch。

miniProgram.reLaunch(url: string): Promise<Page>

参数说明

miniProgram.switchTab

跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面，同 wx.switchTab。

miniProgram.switchTab(url: string): Promise<Page>

参数说明

miniProgram.currentPage

获取当前页面。

miniProgram.currentPage(): Promise<Page>

miniProgram.systemInfo

获取系统信息，同 wx.getSystemInfo。

miniProgram.systemInfo(): Promise<Object>

示例代码：

automator.launch().then(async miniProgram => {
  const systemInfo = await miniProgram.systemInfo()
  if (systemInfo.platform === 'devtools') {
    // Do something
  }
})

miniProgram.callWxMethod

调用 wx 对象上的指定方法。

miniProgram.callWxMethod(method: string, ...args: any[]): Promise<any>

参数说明

调用异步方法时无需传入 success 及 fail 回调函数。

示例代码：

automator.launch().then(async miniProgram => {
  await miniProgram.callWxMethod('setStorage', {
    key: 'test',
    data: 'test'
  })
  const { data } = await miniProgram.callWxMethod('getStorageSync', 'test')
  console.log(data) // -> 'test'
})

miniProgram.mockWxMethod

覆盖 wx 对象上指定方法的调用结果。

miniProgram.mockWxMethod(method: string, result: any): Promise<void>

参数说明

利用该接口，你可以很方便地直接指定 wx.chooseLocation 等调用系统组件的返回结果。

示例代码：

automator.launch().then(async miniProgram => {
  await miniProgram.mockWxMethod('showModal', {
    confirm: true,
    cancel: false
  })
})

miniProgram.restoreWxMethod

重置 wx 指定方法，消除 mockWxMethod 调用的影响。

miniProgram.restoreWxMethod(method: string): Promise<void>

参数说明

示例代码：

automator.launch().then(async miniProgram => {
  console.log(await miniProgram.callWxMethod('getStorageSync', 'test')) // -> ''
  await miniProgram.mockWxMethod('getStorageSync', 'mockValue')
  console.log(await miniProgram.callWxMethod('getStorageSync', 'test')) // -> 'mockValue'
  await miniProgram.restoreWxMethod('getStorageSync')
  console.log(await miniProgram.callWxMethod('getStorageSync', 'test')) // -> ''
})

miniProgram.evaluate

往 AppService 注入代码片段并返回执行结果。

miniProgram.evaluate(appFunction: Function | string, ...args: any[]): Promise<any>

参数说明

appFunction 最终会被序列化传递到开发者工具，因此你无法在函数中利用闭包来引用外部变量。也就是说，传递 function () {} 函数事实上等同于传递其字符串。

示例代码：

automator.launch().then(async miniProgram => {
  let systemInfo = await miniProgram.evaluate(() => {
    return new Promise(resolve => {
      wx.getSystemInfo({
        success(result) {
          resolve(result)
        }
      })
    })
  })
  systemInfo = await miniProgram.evaluate(() => {
    return wx.getSystemInfoSync()
  })
  console.log(systemInfo)
  await miniProgram.evaluate(key => {
    wx.setStorageSync(key, 'test')
  }, 'test')
  const hasLogin = await miniProgram.evaluate(() => getApp().globalData.hasLogin)
  console.log(hasLogin)
})

miniProgram.pageScrollTo

将页面滚动到目标位置，同 wx.pageScrollTo。

miniProgram.pageScrollTo(scrollTop: number): Promise<void>

参数说明

示例代码：

automator.launch().then(async miniProgram => {
  await miniProgram.pageScrollTo(50)
})

miniProgram.exposeFunction

在 AppService 全局暴露方法，供小程序侧调用测试脚本中的方法。

miniProgram.exposeFunction(name: string, bindingFunction: Function): Promise<void>

参数说明

你可以利用该方法来监听事件，不支持在小程序侧获取调用结果。

示例代码：

automator.launch().then(async miniProgram => {
  await miniProgram.exposeFunction('onAppShow', options => {
    // Do something... 
  })
  await miniProgram.evaluate(function() {
    wx.onAppShow(function(options) {
      onAppShow(options)
    })
  })
})

miniProgram.remote

开启工具真机调试功能。

miniPromise.remote(auto?: boolean): Promise<void>

参数说明

调用后脚本会启动工具真机调试功能，并且在控制台上打印二维码，然后你需要使用真机扫码连接使自动化脚本继续跑下去。

auto 为 true 时，真机上会自动调起小程序，无需扫码，仅支持微信 7.0.6（安卓）、6.6.7（iOS）及以上版本。有关真机自动化相关内容，请点此查看。

automator.launch().then(async miniProgram => {
  await miniProgram.remote()
  // 扫码连接成功后在真机上执行自动化脚本
})

miniProgram.disconnect

断开与小程序运行时的连接。

miniProgram.disconnect(): void

示例代码：

automator.launch().then(async miniProgram => {
  miniProgram.disconnect()
})

miniProgram.close

断开与小程序运行时的连接并关闭项目窗口。

miniProgram.close(): Promise<void>

示例代码：

automator.launch().then(async miniProgram => {
  await miniProgram.close()
})

事件

console

日志打印时触发。

传递一个 msg 参数，其字段如下：

示例代码：

automator.launch().then(async miniProgram => {
  miniProgram.on('console', msg => {
    console.log(msg.type, msg.args)
  })
})

exception

页面 JS 出错时触发。

传递一个 error 参数，其字段如下：

示例代码：

automator.launch().then(async miniProgram => {
  miniProgram.on('exception', err => {
    console.log(err.message, err.stack)
  })
})