微信小程序 API 的 TypeScript 类型定义文件
通过 npm 安装:
# 安装对应最新基础库的定义文件
npm install miniprogram-api-typings
或者通过版本号指定一个基础库版本:
# 安装对应基础库版本 2.4.1 的定义文件
npm install [email protected]
所有可用的版本和对应的基础库版本,参考 VERSIONS.md
参考 CHANGELOG.md
API 的定义文件(lib.wx.api.d.ts
)是随 文档 一起自动生成的,如果发现了 API 接口的定义错误,请提一个 issue 给我们,关于 API 的 PR 将 不会 被接受。
如果有针对页面(Page
)、自定义组件(Component
)等接口的 bug 和建议,欢迎 PR 或提一个 issue 给我们。非常感谢!
本定义文件使用 dtslint
进行测试,所有的测试样例放在 test
目录下。
想执行测试的话,克隆本项目并完成 npm install --save-dev
后执行 npm test
即可。
如果您发现了不能通过自动化测试的测试样例,可以提交 PR 或者提一个 issue。当然,能通过自动化测试的强有力的测试样例也是欢迎的。