Skip to content

Type definitions for APIs of Wechat Mini Program in TypeScript

License

Notifications You must be signed in to change notification settings

starriv/api-typings

 
 

Repository files navigation

微信小程序定义文件

English version

已在 NPM 发布 MIT 协议 Travis CI 测试状况

微信小程序 API 的 TypeScript 类型定义文件

安装

通过 npm 安装:

# 安装对应最新基础库的定义文件
npm install miniprogram-api-typings

或者通过版本号指定一个基础库版本:

# 安装对应基础库版本 2.4.1 的定义文件
npm install miniprogram-api-typings@2.4.1

版本

所有可用的版本和对应的基础库版本,参考 VERSIONS.md

更新日志

参考 CHANGELOG.md

贡献

API 的定义文件(lib.wx.api.d.ts)是随 文档 一起自动生成的,如果发现了 API 接口的定义错误,请提一个 issue 给我们,关于 API 的 PR 将 不会 被接受。

如果有针对页面(Page)、自定义组件(Component)等接口的 bug 和建议,欢迎 PR 或提一个 issue 给我们。非常感谢!

测试

本定义文件使用 tsd 进行测试,所有的测试样例放在 test 目录下。

想执行测试的话,克隆本项目并完成 npm install --save-dev 后执行 npm test 即可。

如果您发现了不能通过自动化测试的测试样例,可以提交 PR 或者提一个 issue。当然,能通过自动化测试的强有力的测试样例也是欢迎的。

About

Type definitions for APIs of Wechat Mini Program in TypeScript

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 100.0%