当前位置: 首页 > 文档资料 > MPX 中文文档 >

API 转换

优质
小牛编辑
130浏览
2023-12-01

convert API at each end 各个平台之间 api 进行转换,目前已支持微信转支付宝、微信转web

Usage

// 使用 mpx 生态

import mpx from '@mpxjs/core'
import apiProxy from '@mpxjs/api-proxy'

mpx.use(apiProxy, options)
// 单独使用
import apiProxy from '@mpxjs/api-proxy'

apiProxy(target, options) // target 为要抹平的对象

Options

参数名称类型含义是否必填默认值备注
platformObject各平台之间的转换{ from:'', to:'' }使用 mpx 脚手架配置会自动进行转换,无需配置
excludeArray(String)跨平台时不需要转换的 api-
usePromiseBoolean是否将 api 转化为 promise 格式使用false-
whiteListArray(String)强行转化为 promise 格式的 api[]需要 usePromise 设为 true
blackListArray(String)强制不变成 promise 格式的 api[]-
fallbackMapObject对于不支持的API,允许配置一个映射表,接管不存在的API{}-

example

普通形式

import mpx from '@mpxjs/core'
import apiProxy from '@mpxjs/api-proxy'

mpx.use(apiProxy, {
  exclude: ['showToast'] // showToast 将不会被转换为目标平台
})

mpx.showModal({
  title: '标题',
  content: '这是一个弹窗',
  success (res) {
    if (res.cancel) {
      console.log('用户点击取消')
    }
  }
})

使用promise形式

import mpx from '@mpxjs/core'
import apiProxy from '@mpxjs/api-proxy'

mpx.use(apiProxy, {
  usePromise: true
})

mpx.showActionSheet({
  itemList: ['A', 'B', 'C']
})
.then(res => {
  console.log(res.tapIndex)
})
.catch(err => {
  console.log(err)
})