Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@mpxjs/api-proxy

Package Overview
Dependencies
Maintainers
6
Versions
168
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@mpxjs/api-proxy

convert miniprogram API at each end

  • 2.7.0-beta.1
  • npm
  • Socket score

Version published
Weekly downloads
42
increased by31.25%
Maintainers
6
Weekly downloads
 
Created
Source

mpx-api-proxy

convert API at each end 各个平台之间 api 进行转换

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[]-
customObject自定义对应平台的转换规则{}-
usePromiseBoolean是否将 api 转化为 promise 格式使用false-
whiteListArray(String)强行转化为 promise 格式的 api[]需要 usePromise 设为 true

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,
  custom: { // 自定义微信到百度的 compressImage 转换规则,支持 wx、ali、swan、qq、tt
    'wx_swan': {
      compressImage (options = {}) {
        const res = {}
        // TODO
        options.success && options.success(res)
      }
    }
  }
})

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

Done

  • 微信 → 支付宝
  • 百度 → 支付宝
  • QQ → 支付宝

Keywords

FAQs

Package last updated on 03 Nov 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc