Skip to content

wechat-miniprogram/minigame-api-typings

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Mar 17, 2025
6e66150 · Mar 17, 2025

History

67 Commits
Mar 17, 2025
Feb 8, 2025
Mar 17, 2025
Aug 8, 2024
Feb 26, 2020
Jul 7, 2021
Mar 17, 2025
Apr 16, 2019
Jul 2, 2021
Jul 2, 2021
Apr 16, 2019
Mar 17, 2025
Mar 17, 2025
Mar 18, 2020
Apr 16, 2019

Repository files navigation

微信小游戏定义文件

English version

已在 NPM 发布 MIT 协议 GitHub Actions 测试状况

微信小游戏 API 的 TypeScript 类型定义文件

安装

npm install minigame-api-typings

安装后手动导入:

  • import 'minigame-api-typings';

或者在 ts 配置中指定:

  • tsconfig.json 中指定 types: ["minigame-api-typings"]

或者通过 三斜杠指令 引用:

  • /// <reference path="node_modules/minigame-api-typings/index.d.ts" />

更新日志

参考 CHANGELOG.md

贡献

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

测试

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

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

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

About

Type definitions for APIs of Wechat Mini Game in TypeScript

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3