jweixin-esm

微信 JSSDK, ESM 模块, 附带 TS 类型以及详细注释

About

基于微信官方的 JSSDK jweixin-1.6.0.js 改造的 ESM 模块，支持 TypeScript 类型，并且附带完整的注释文档。微信官方文档

Installation

pnpm add @wtto00/jweixin-esm
# npm i @wtto00/jweixin-esm
# yarn add @wtto00/jweixin-esm

Usage

import weixin from '@wtto00/jweixin-esm'
// or:
// import '@wtto00/jweixin-esm'

// weixin的类型是WX，已全局声明

console.log(weixin) // 导入的名称
console.log(window.wx) // wx已挂载全局window
console.log(window.jWeixin) // jWeixin已挂载全局window

// 这里 weixin=window.wx=window.jWeixin

// 所有的类型全部在WX中，可以直接使用，不用额外导入或配置。已全局声明。

const configData: WX.ConfigOptions = {
  debug: true,
  appId: '',
  timestamp: '',
  nonceStr: '',
  signature: '',
  jsApiList: [], // WX.JsApi[]
  openTagList: [] // WX.OpenTag[]
}
weixin.config(configData)

Note

使用过程中有任何问题，请提 ISSUE。也非常欢迎所有的 PR。

有一些接口我只是看官方文档写的类型定义，并没有全部测试过，所以可能是会有错误的。如果发现了错误，麻烦提个 ISSUE，非常感谢。