微信小程序定义文件
English version
微信小程序 API 的 TypeScript 类型定义文件
安装
通过独立 npm 包
npm install miniprogram-api-typings
安装后手动导入:
import 'miniprogram-api-typings';
或者在 ts 配置中指定:
- 在
tsconfig.json
中指定 types: ["miniprogram-api-typings"]
或者通过 三斜杠指令 引用:
/// <reference path="node_modules/miniprogram-api-typings/index.d.ts" />
或:
通过 DefinitelyTyped
npm install @types/wechat-miniprogram
更新日志
参考 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。当然,能通过自动化测试的强有力的测试样例也是欢迎的。