/minapp-promise

不到 1KB 的小程序异步接口 Promise 化

Primary LanguageJavaScriptMIT LicenseMIT

minapp-promise

不到 1KB 的小程序异步接口 Promise 化，支持所有小程序异步接口

如何使用

  1. 通过 npm 安装（确保已开启 使用 npm 模块 功能）

    npm install minapp-promise

  2. 构建

    在微信开发者工具中依次点击 工具 - 构建 npm

  3. 在代码中引入

    import pro from 'minapp-promise'

pro.showToast({ title }).then(doSomething)
pro.request({ url }).then(handleResponse).catch(handleError)

注意事项

  • 确保开发者工具中 ES6 转 ES5 选项开启

    minapp-promise 使用 ES6 新特性 Proxy 来代理 wx 对象，而现阶段仅有 iOS 10+ 支持这个特性（信息来源）。

  • 仅支持带有 success 和 fail 回调的异步接口

    为了实现起来更方便，并未对 wx 对象中的同步接口进行特殊处理，使用者须自行甄别接口文档中的异步接口

  • complete 支持

    原生 Promise 并不支持 finally 方法，为此，如果你想使用 complete 回调，请作为参数传递

    pro.showToast({
  title: 'Hello, world',
  complete: () => console.log('showToast completed'),
})
  .then(() => console.log('showToast succeeded'))
  .catch(() => console.log('showToast failed'))

更新记录

v0.0.2

Chores:

  • 更新文档
  • 添加 wx declare 以去除 flow 报错

v0.0.1

Feats:

  • 实现功能