miniprogram-api-typings
Advanced tools
Type definitions for APIs of Wechat Mini Program in TypeScript
微信小程序 API 的 TypeScript 类型定义文件
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" />或：
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。当然，能通过自动化测试的强有力的测试样例也是欢迎的。
2025-07-15 v4.1.0
getOpenerEventChannel 的返回值的类型，使其有可能返回空对象，以正确反映实际情况。这是一个 破坏性改动，getOpenerEventChannel 的返回值上的 emit, on 等方法不再可以直接调用 (#350)FAQs
Type definitions for APIs of Wechat Mini Program in TypeScript
The npm package miniprogram-api-typings receives a total of 69,880 weekly downloads. As such, miniprogram-api-typings popularity was classified as popular.
We found that miniprogram-api-typings demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
npm now supports Trusted Publishing with OIDC, enabling secure package publishing directly from CI/CD workflows without relying on long-lived tokens.
Research
/Security News
A RubyGems malware campaign used 60 malicious packages posing as automation tools to steal credentials from social media and marketing tool users.
Security News
The CNA Scorecard ranks CVE issuers by data completeness, revealing major gaps in patch info and software identifiers across thousands of vulnerabilities.