/wxsdk-dts

微信API的TS封装,即d.ts文件。2015年1月10日在微信官方推出JSSDK后创建

Primary LanguageJavaScriptMIT LicenseMIT

wxsdk-dts

=================== 本项目为微信JS SDK的TypeScript定义,即d.ts文件。

于2015年1月10日在微信官方推出JS SDK后创建。

微信API具体是指 微信公众平台开发者文档 所述的jweixin-1.0.0.js的API。

本项目主要用于 Egret引擎 开发者在Egret开发过程方便的调用微信相关的功能。

另外本项目已经对官方一些常用的API如分享到朋友圈等的参数结构进行了定义,方便开发者更快捷地完成相关属性配置。

使用方法

在经过验证可以稳定无误使用后, egret-game-library 中将会加入该模块方便适用。

目前果开发者使用此模块,请按照以下方式添加到游戏中:

  • 下载并复制一份 微信公众平台官方SDK文件jweixin-1.0.0.js 为Egret项目中的 launcher/jweixin-1.0.0.js

  • 复制本项目的 jweixin-1.0.0-additional.js 为Egret项目中的 launcher/jweixin-1.0.0-additional.js

  • 在游戏项目的 index.htmlrelease.html 中添加:
    <script src="launcher/jweixin-1.0.0.js" async="false"></script> 以及
    <script src="launcher/jweixin-1.0.0-additional.js" async="false"></script>

  • 复制本项目的 jweixin-1.0.0.d.ts 为Egret项目中的 libs/jweixin-1.0.0.d.ts

  • 在Egret项目的TS文件中,对照微信公众平台开发者文档,直接调用其相关API。如下为基本用法示例:

var bodyConfig:BodyConfig = new BodyConfig;
bodyConfig.appId = "aaabbb";
bodyConfig.debug = true;
/// ... 其他的配置属性赋值
/// 通过config接口注入权限验证配置
wx.config( bodyConfig );
wx.ready( function(){
    /// 在这里调用微信相关功能的 API
} )