# wpjs

**Repository Path**: CoderLPF/wpjs

## Basic Information

- **Project Name**: wpjs
- **Description**: 针对小程序API封装的Promise库
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 9
- **Created**: 2020-10-16
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[API地址](https://xiaochangzai_890.gitee.io/wpjs/out/global.html)

公众号

![前端撸客](http://sunchang.oss-cn-beijing.aliyuncs.com/weixin/qrcode_for_gh_df5ed2a305ab_258.jpg)
---

## 针对小程序API封装的Promise库
#### wp.canIUse
```
wp.canIUse('openBluetoothAdapter')
wp.canIUse('getSystemInfoSync.return.screenWidth')
wp.canIUse('getSystemInfo.success.screenWidth')
wp.canIUse('showToast.object.image')
wp.canIUse('onCompassChange.callback.direction')
wp.canIUse('request.object.method.GET')

wp.canIUse('live-player')
wp.canIUse('text.selectable')
wp.canIUse('button.open-type.contact')
```
#### getSystemInfoSyncTest
同 `wx.getSystemInfoSync`，[返回值查看](https://developers.weixin.qq.com/miniprogram/dev/api/wx.getSystemInfoSync.html)

用法：
```
let info =  wp.getSystemInfoSync()
console.log(info)
```
#### wp.getSystemInfo
获取系统信息, `wx.getSystemInfo`的升级版，将传统的回调函数改成链式调用的方式
```
wp.getSystemInfo()
    .success(res => {
        console.log('获取信息成功')
        console.log(res)
        console.log(res.model)
        console.log(res.pixelRatio)
        console.log(res.windowWidth)
        console.log(res.windowHeight)
        console.log(res.language)
        console.log(res.version)
        console.log(res.platform)
    }).complete(res => {
        console.log('获取信息完毕')
        console.log(res)
    }).fail(err => {
        console.error('获取信息出错')
        console.error(err)
    })
```

`res` [的参数详情请点击这里](https://developers.weixin.qq.com/miniprogram/dev/api/wx.getSystemInfo.html)

#### wp.getLaunchOptionsSync
同 `wx.getLaunchOptionsSync` 返回值请参考 [wx.getLaunchOptionsSync](https://developers.weixin.qq.com/miniprogram/dev/api/wx.getLaunchOptionsSync.html)

---
## 路由
#### wp.switchTab
 `wx.switchTab`升级版，同样采用链式操作调用回调函数。用法：
```
wp.switchTab('/pages/index/index')
    .success(res => {
        console.log('跳转成功！')
    }).complete(res => {
        console.log('跳转完成！')
    }).fail(err => {
        console.log('跳转失败！')
    })
```
#### wp.reLaunch
 `wx.reLaunch`升级版，同样采用链式操作调用回调函数。用法：
```
wp.reLaunch('/pages/index/index')
    .success(res => {
        console.log('跳转成功！')
    }).complete(res => {
        console.log('跳转完成！')
    }).fail(err => {
        console.log('跳转失败！')
    })
```
#### wp.redirectTo
 `wx.redirectTo` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.redirectTo('/pages/index/index')
    .success(res => {
        console.log('跳转成功！')
    }).complete(res => {
        console.log('跳转完成！')
    }).fail(err => {
        console.log('跳转失败！')
    })
```
#### wp.navigateBack
 `wx.navigateBack` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.navigateBack(1)
    .success(res => {
        console.log('跳转成功！')
    }).complete(res => {
        console.log('跳转完成！')
    }).fail(err => {
        console.log('跳转失败！')
    })
```
## 界面
#### wp.showToast
 `wx.showToast` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.showToast({
    title: '标题'
}).success((res) => {
    console.log('提示成功！')
}).complete(() => {
    console.log('提示完成')
})
```
#### wp.showModal
 `wx.showModal` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.showModal({
    title: '标题',
    content: '提示内容',
}).success((res) => {
    console.log('显示模态框')
}).complete(() => {
    console.log('操作完成')
})
```
#### wp.showLoading
 `wx.showLoading` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.showLoading({
  title: '加载中'
}
```
#### wp.showActionSheet
 `wx.showActionSheet` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.showActionSheet({
    itemList: ['A', 'B', 'C']
})
```
#### wp.hideToast
 `wx.hideToast` 升级版
```
wp.hideToast()
```
#### wp.hideLoading
 `wx.hideLoading` 升级版
```
wp.hideLoading()
```
#### wp.showNavigationBarLoading
 `wx.showNavigationBarLoading` 升级版
```
wp.showNavigationBarLoading()
```
#### wp.hideNavigationBarLoading
 `wx.hideNavigationBarLoading` 升级版
```
wp.hideNavigationBarLoading()
```
#### wp.setNavigationBarTitle
 `wx.setNavigationBarTitle` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.setNavigationBarTitle({
    title: '标题'
}).success((res) => {
    console.log('执行成功！')
}).complete(() => {
    console.log('执行完成')
})
```
#### wp.setNavigationBarColor
 `wx.setNavigationBarColor` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.setNavigationBarColor({
  frontColor: '#ffffff',
  backgroundColor: '#ff0000',
  animation: {
    duration: 400,
    timingFunc: 'easeIn'
  }
})
```
#### wp.setBackgroundTextStyle
 `wx.setBackgroundTextStyle` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.setBackgroundTextStyle({
  textStyle: 'dark' // 下拉背景字体、loading 图的样式为dark
})
```
#### wp.setBackgroundColor
 `wx.setBackgroundColor` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.setBackgroundColor({
  backgroundColorTop: '#ffffff', // 顶部窗口的背景色为白色
  backgroundColorBottom: '#ffffff', // 底部窗口的背景色为白色
})
```
#### wp.uploadFile
 `wx.uploadFile` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.uploadFile({
  url: 'https://example.weixin.qq.com/upload', // 仅为示例，非真实的接口地址
  filePath: tempFilePaths[0],
  name: 'file',
  formData: {
    user: 'test'
  }
}).success(res => {
  const data = res.data
  // do something
})
```
#### wp.downloadFile
 `wx.downloadFile` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.downloadFile({
  url: 'https://example.com/audio/123', // 仅为示例，非真实的接口地址
}).success(res => {
   // 只要服务器有响应数据，就会把响应内容写入文件并进入 success 回调，业务需要自行判断是否下载到了想要的内容
   if (res.statusCode === 200) {
     wx.playVoice({
       filePath: res.tempFilePath
     })
   }
})
```
#### wp.request
 `wx.request` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.request({
  url: 'test.php', // 仅为示例，并非真实的接口地址
  data: {
    x: '',
    y: ''
  },
  header: {
    'content-type': 'application/json' // 默认值
  },
  succe
}).success(res => {
   // 只要服务器有响应数据，就会把响应内容写入文件并进入 success 回调，业务需要自行判断是否下载到了想要的内容
   if (res.statusCode === 200) {
     wx.playVoice({
       filePath: res.tempFilePath
     })
   }
})
```
#### wp.saveImageToPhotosAlbum
 `wx.saveImageToPhotosAlbum` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.saveImageToPhotosAlbum()
.success(() => {
    // TODO.
})
```
#### wp.getImageInfo
 `wx.getImageInfo` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.getImageInfo({
   src: 'images/a.jpg'
 }).success(src => {
    // TODO.
 })
```
#### wp.compressImage
 `wx.compressImage` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.compressImage({
   src: 'images/a.jpg'
 }).success(src => {
    // TODO.
 })
```
#### wp.chooseImage
 `wx.chooseImage` 升级版，同样采用链式操作调用回调函数。用法：
```
wp.chooseImage({
  count: 1,
  sizeType: ['original', 'compressed'],
  sourceType: ['album', 'camera']
}).success(res => {
  // tempFilePath可以作为img标签的src属性显示图片
  const tempFilePaths = res.tempFilePaths
})
```