mpapi
v0.2.2
mpapi（miniProgram API），小程序 API 兼容插件，一次编写，多端运行。
⏰ 更新日期: 2019-05-31，小程序功能一直在更新，新版本可能有所差异，请留意。
此项目解决的问题：寻找不同小程序 API 之间的差异，尽可能地通过一套 API 兼容多个小程序使用。
api.showToast 可以直接传 string、api.setStorageSync 无需调用 try catch 等request、downloadFile，详情api.isWechat、api.isAlipay、api.isSwan、api.isTtnpm install mpapi --save非 npm 安装方式，直接引入 lib 目录下的 mpapi.js 到项目即可
const api = require('mpapi')
api.alert({...}).then((res) => {})
api.confirm({...}).then((res) => {})
api.getLocation().then((res) => {})
...request、downloadFile、uploadFile 等所有小程序都可以使用的 API
交互
alertconfirmshowToastshowLoadingshowActionSheet导航栏
setNavigationBarTitlesetNavigationBarColor文件
saveFilegetFileInfogetSavedFileInfogetSavedFileListremoveSavedFile图片
chooseImagepreviewImagecompressImagesaveImageToPhotosAlbum请求
requestuploadFiledownloadFile数据缓存
setStorageSyncgetStorageSyncclearStorageSyncgetStorageInfoSyncremoveStorageSync系统设备
getSystemInfoSyncsetScreenBrightnessgetScreenBrightnessmakePhoneCallscanCodesetClipboardDatagetClipboardData只在特定小程序下才会支持
微信小程序
、支付宝小程序
、百度智能小程序
、字节跳动小程序
，有图标表示只支持对应小程序，没有图标表示都支持。
交互
hideToasthideLoadingshowModal prompt 缓存
getStoragesetStorageremoveStoragegetStorageInfo路由
reLaunchswitchTabredirectTonavigateTonavigateBack位置
getLocationopenLocationchooseLocation 文件图片
saveImage getImageInfochooseVideo chooseMessageFile saveVideoToPhotosAlbum openDocument 音频
stopVoice playVoice getAvailableAudioSources stopBackgroundAudio playBackgroundAudio seekBackgroundAudio pauseBackgroundAudio getBackgroundAudioPlayerState setInnerAudioOption startRecord stopRecord stopRecord 导航栏
getTitleColor setNavigationBar showNavigationBarLoading hideNavigationBarLoading 背景
setBackgroundTextStyle setBackgroundColor showTabBar hideTabBar setTabBarItem setTabBarStyle showTabBarRedDot hideTabBarRedDot setTabBarBadge removeTabBarBadge 下拉刷新
startPullDownRefreshstopPullDownRefresh滚动
pageScrollTosendSocketMessage connectSocketcloseSocket startLocalServiceDiscovery stopLocalServiceDiscovery 置顶
setTopBarText 画布
canvasGetImageData canvasPutImageData canvasToTempFilePath 分享转发
getShareInfo updateShareMenu showShareMenu hideShareMenu showFavoriteGuide openShare 登录、授权、用户信息
login checkSession getUserInfo getAuthCode getAuthUserInfo getPhoneNumber authorize 支付
tradePay requestPayment requestPolymerPayment 开放接口
getSettingopenSettingreportAnalyticschooseInvoiceTitle navigateToMiniProgram navigateBackMiniProgram 开放接口 - 微信小程序
addCard openCard chooseInvoice startSoterAuthentication checkIsSoterEnrolledInDevice checkIsSupportSoterAuthentication getWeRunData 开放接口 - 支付宝小程序
startZMVerify textRiskIdentification addCardAuth getRunScene chooseCity datePicker optionsSelect multiLevelSelect rsa 开放接口 - 百度智能小程序
getSwanId navigateToSmartProgram navigateBackSmartProgram setPageInfo setMetaDescription setMetaKeywords setDocumentTitle loadSubPackage 联系人
chooseAddress chooseContact choosePhoneContact chooseAlipayContact addPhoneContact 字体加载
loadFontFace 系统信息
getSystemInfogetBatteryInfo getNetworkTypesetKeepScreenOn startAccelerometer stopAccelerometer startCompass stopCompass startDeviceMotionListening stopDeviceMotionListening startGyroscope stopGyroscope vibrate vibrateShortvibrateLongwatchShake setEnableDebug getServerTime scan 蓝牙无线
getBeacons startBeaconDiscovery stopBeaconDiscovery startWifi stopWifi setWifiList getWifiList connectWifi getConnectedWifi getBLEDeviceServices getBLEDeviceCharacteristics createBLEConnection closeBLEConnection writeBLECharacteristicValue readBLECharacteristicValue notifyBLECharacteristicValueChange startBluetoothDevicesDiscovery stopBluetoothDevicesDiscovery openBluetoothAdapter getConnectedBluetoothDevices getBluetoothDevices getBluetoothAdapterState closeBluetoothAdapter stopHCE startHCE getHCEState sendHCEMessage 第三方平台
getExtConfig 深层级的 API，注意：方法加了 $ 前缀
api.ap
api.ap.$faceVerifyapi.ap.$navigateToAlipayPage...api.ai
api.ai.$ocrIdCardapi.ai.$ocrBankCard...某些新实例的对象上面的 API
createMapContext createVideoContext createAudioContext createCameraContext createInnerAudioContext createLivePusherContext createLivePlayerContext getBackgroundAudioManager getRecorderManager createSelectorQuerygetFileSystemManager createARCameraContext 例如：注意：方法加了 $ 前缀
let ctx = api.createMapContext('maper')
ctx.$getCenterLocation().then((res) => {
console.log('createMapContext:getCenterLocation')
console.log(res)
})1、传参不一致
例如：showLoading 方法，加载的显示文案，微信和百度里面是 title 参数，支付宝里面是 content 参数，如下
// 微信
wx.showLoading({
title: '加载中'
})
// 百度
swan.showLoading({
title: '加载中'
})
// 支付宝
my.showLoading({
content: '加载中'
})
// 使用 mpapi 之后，多端兼容
api.showLoading('加载中')
api.showLoading({
title: '提示内容'
})2、返回参不一致
例如：showActionSheet 方法，执行完之后获取选择的索引，微信和百度里面是 res.tapIndex，支付宝里面是 res.index，如下
// 微信
wx.showActionSheet({
itemList: ['台球', '羽毛球', '篮球'],
success: (res) => {
// res.tapIndex
}
})
// 支付宝
my.showActionSheet({
items: ['台球', '羽毛球', '篮球'],
success: (res) => {
// res.index
}
})
// 使用 mpapi，多端兼容
api.showActionSheet({
itemList: ['台球', '羽毛球', '篮球'],
success: (res) => {
// res.tapIndex
}
})3、不支持，但可兼容
例如：支付宝里面有 my.alert，而微信和百度里面没有此方法，但是可以通过微信的 wx.showModal 或百度的 swan.showModal 封装一个 alert 方法，如下
api.alert('提示内容')
api.alert({
content: '提示内容'
})
// 请求数据，兼容多端
api.request({...}).then((res) => {})4、不支持，无法兼容
有的 API 只在特定端里面有效，无法兼容处理，如下
// 只在支付宝里面有效，微信和百度小程序里面会报错
api.startZMVerify({...})
// 建议这样处理
if(api.isAlipay){
api.startZMVerify({...})
}
// 只在微信里面有效，支付宝或百度小程序里面会报错
api.setTopBarText({...})
// 建议这样处理
if(api.isWechat){
api.setTopBarText({...})
}
// 百度智能小程序的特殊 API 一样的道理
if(api.isSwan){
api.getSwanId().then((res) => {})
}1、支持 Promise 风格
所有小程序的 API 只要包含 success 回调，都已经用 Promise 封装过，可以直接使用，两种写法都支持，例如
// 使用回调
api.showActionSheet({
itemList: ['台球', '羽毛球', '篮球'],
success: (res) => {
// res.tapIndex
}
})
// 或者
api.showActionSheet({
itemList: ['台球', '羽毛球', '篮球']
}).then((res) => {
// res.tapIndex
})
// 其它
api.setStorage({...}).then((res) => {})
api.chooseImage({...}).then((res) => {})
...2、兼容方法里的传参和返回参，以微信小程序调用为准。其它端不兼容的参数不处理（某些参数也无法处理，特定小程序不支持）开发者需要留意，例如
api.chooseImage({
count: 1,
sizeType: ['original', 'compressed'], // 只在微信可用
sourceType: ['album', 'camera'],
}).then((res) => {
// res.tempFilePaths 在微信和支付宝都可用
// res.tempFiles 只在微信可用
})某些 API 既要支持 Promise，又要调用它的事件，那么可以采用如下方式：
以前：
const downloadTask = wx.downloadFile({
url: 'https://example.com/audio/123', // 仅为示例，并非真实的资源
success(res){
console.log(res)
}
})
downloadTask.onProgressUpdate((res) => {
console.log(res)
})
downloadTask.abort() // 取消下载任务使用 mpapi 之后：
const api = require('mpapi')
const downloadTask = api.downloadFile({
url: 'https://example.com/audio/123' // 仅为示例，并非真实的资源
}).then((res) => {
console.log('success')
console.log(res)
})
downloadTask.$event('onProgressUpdate', (res) => {
console.log(res)
})
// downloadTask.$event('abort') // 取消下载任务其它 API 可以类似处理，例如：request、uploadFile、connectSocket
如果您在使用过程中发现 Bug，或者有好的建议，欢迎报告问题。
更新日志
