bravf/wxDefer

微信小程序API增强

wxDefer

将微信小程序中接受 { success: callback, fail: callback, complete: callback } 的函数转化为类似 jQuery.Deferred 的形式

原接口对比wxDefer

wx.request({
    url: 'https://example.com/data.json',
    data: {
        _: +new Date
    },
    success: (response) => {
        if ('request:ok' == response.errMsg) {
            this.setData({
                exampleData: response.data
            })
        }
    },
    fail: (response) => {
        console.log(response)
    }
})

使用 wxDefer

var wxDefer = require('../../wxDefer.js')

wxDefer.request({
    url: 'https://example.com/data.json',
    data: {
        _: +new Date
    }
}).done((response) => {
    if ('request:ok' == response.errMsg) {
        this.setData({
            exampleData: response.data
        })
    }
}).fail((response) => {
    console.log(response)
})

支持的微信API列表

完整的微信API列表

• 网络 API 列表
  • request: 发起网络请求
  • uploadFile: 上传文件
  • downloadFile: 下载文件
  • connectSocket: 创建 WebSocket 连接
• 媒体 API 列表
  • chooseImage: 从相册选择图片，或者拍照
  • previewImage: 预览图片
  • startRecord: 开始录音
  • playVoice: 播放语音
  • stopVoice: 结束播放语音
  • getBackgroundAudioPlayerState: 获取音乐播放状态
  • playBackgroundAudio: 播放音乐
  • seekBackgroundAudio: 控制音乐播放进度
  • chooseVideo: 从相册选择视频，或者拍摄
  • saveFile: 保存文件
• 数据 API 列表
  • getStorage: 获取本地数据缓存
  • setStorage: 设置本地数据缓存
• 位置 API 列表
  • getLocation: 获取当前位置
  • openLocation: 打开内置地图
• 设备 API 列表
  • getNetworkType: 获取网络类型
  • getSystemInfo: 获取系统信息
• 界面 API 列表
  • setNavigationBarTitle: 设置当前页面标题
  • navigateTo: 新窗口打开页面
  • redirectTo: 原窗口打开页面
• 开放接口
  • login: 登录
  • getUserInfo: 获取用户信息
  • requestPayment: 发起微信支付

其它 API

wxDefer.Deferred

Deferred 类

类似jQuery.Deferred(文档)，请注意：当前wxDeferred只是最小支持，部分jQuery.Deferred的接口并不支持

函数	返回类型	说明
state()	pending | resolved | rejected	当前Deferred的状态
done(callback)	Deferred()	Deferred()状态变成resolved时的回调函数
fail(callback)	Deferred()	Deferred()状态变成rejected时的回调函数
always(callback)	Deferred()	Deferred()状态变成resolved或rejected时均会触发的回调函数
resolve(...args)	无	改变Deferred的状态为resolved并使用args调用相关回调函数
resolveWith(thisObj, ...args)	无	改变Deferred的状态为resolved并使用args调用相关回调函数（可以设置回调函数中的this）
reject(...args)	无	改变Deferred的状态为resolved并使用args调用相关回调函数
rejectWith(thisObj, ...args)	无	改变Deferred的状态为resolved并使用args调用相关回调函数（可以设置回调函数中的this）

另请注意：wxDefer.Deferred是类的构造函数，而jQuery.Deferred()则返回初始化后的对象

var defer = new wxDefer.Deferred()
defer.done(_ => console.log('done: ', _)).fail(_ => console.warn('fail'))

defer.resolve('success!')
// in console:
// done: success!

wxDefer.MakeDeferred()

将可以接受 { success: callback, fail: callback, complete: callback } 的API函数转化为 Deferred 的形式

在wxDefer未更新的情况增加Deferred形式的函数

function demoFunction(config) {
    // config 包含 success, fail, complete 三个回调函数
    // ...
}

var demoFunctionDeferred = wxDefer.MakeDeferred(demoFunction)

更新

• 2016.9.28 v0.1 初始版本