# 微信 & 抖音小游戏 TypeScript API 类型声明

🚀 为微信小游戏和抖音小游戏提供完整、准确的 TypeScript 类型定义

--- ## 📖 简介本仓库提供了**微信小游戏**和**抖音小游戏**平台 API 的完整 TypeScript 类型声明文件（`.d.ts`）。让您在使用 TypeScript 开发小游戏时，享受一流的 IDE 智能提示、编译期类型检查和详尽的参数说明。 ### 为什么需要这个库？官方提供的小游戏 API 类型声明通常不完整或更新滞后。本仓库致力于： - ✅ **完整性** — 覆盖微信小游戏和抖音小游戏几乎全部公开 API - ✅ **准确性** — 每个接口、参数、回调都经过仔细校对和中文注释 - ✅ **时效性** — 紧跟平台更新，持续同步最新 API - ✅ **开箱即用** — 无需额外配置，引入即可获得完整的类型支持 --- ## 📦 快速开始 ### 方式一：直接复制到项目将 `lib/` 目录下的声明文件复制到您的 TypeScript 小游戏项目中： ```bash # 微信小游戏 cp lib/lib.wx.api.d.ts your-project/src/types/ # 抖音小游戏 cp lib/lib.tt.api.d.ts your-project/src/types/ ``` ### 方式二：配置 tsconfig.json 在项目的 `tsconfig.json` 中引入声明文件： ```json { "compilerOptions": { "typeRoots": ["./types", "./node_modules/@types"] }, "include": ["src/**/*", "types/**/*"] } ``` --- ## 🎮 覆盖范围 ### 微信小游戏 (`lib.wx.api.d.ts`) | 模块 | 说明 | |------|------| | 🖥️ 基础 | 系统信息、生命周期、启动参数 | | 🔐 登录 & 认证 | 登录、授权、用户信息、设置 | | 🎨 界面 | Toast、Modal、Loading、ActionSheet、键盘 | | 💾 缓存 | Storage 同步/异步操作 | | 🌐 网络 | 请求、上传、下载、WebSocket | | 🎵 媒体 | 音频、视频、图片、录音、相机 | | 🎮 渲染 | Canvas 2D、WebGL、WebAudio | | 📢 广告 | BannerAd、激励视频、插屏广告、原生模板广告、格子广告 | | 👥 开放数据域 | 排行榜、关系链数据 | | 🔌 硬件 | 蓝牙、NFC、设备运动、传感器 | | 💬 社交 | 分享、送礼、游戏圈、客服 | | 📁 文件系统 | 文件管理、解压缩、Stats | | 🖱️ PC 平台 | 鼠标、键盘、滚轮、光标锁定 | | ... | 以及更多 | > 共计 **24,000+ 行**类型声明，涵盖数百个 API 接口。 ### 抖音小游戏 (`lib.tt.api.d.ts`) | 模块 | 说明 | |------|------| | 🖥️ 系统信息 | `getSystemInfo` / `getSystemInfoSync` | | 🔐 登录 & 用户 | 登录、Session、用户信息、授权、实名认证 | | 🎨 界面交互 | Toast、Loading、Modal、ActionSheet | | ⌨️ 键盘 | 显示/隐藏/更新键盘、事件监听 | | 💾 数据缓存 | Storage 增删改查 | | 🌐 网络 | HTTP 请求、上传、下载 | | 🎵 媒体 | 图片、视频、音频、录音 | | 🎨 Canvas | 画布、渲染、开放数据域 | | 📁 文件管理 | 文件读写、目录管理 | | 🎯 其他 | 订阅消息、触摸事件、内存警告、事件系统 | > 共计 **2,300+ 行**类型声明，涵盖 38 个分类模块。 --- ## ✨ 使用效果引入类型声明后，您的 IDE 将提供： ```typescript // 1. 精确的 API 自动补全 wx.getSystemInfo({ success: (res) => { // res 的类型被自动推断，无需手动标注 console.log(res.system, res.platform, res.brand) } }) // 2. 参数类型检查（编译期发现错误） wx.showToast({ title: 123, // ❌ 类型错误：number 不能赋值给 string icon: 'none' // ✅ 正确 }) // 3. 回调函数参数自动推导 wx.request({ url: 'https://api.example.com/data', success(res) { // res.data 类型已自动推导 console.log(res.data) } }) ``` --- ## 🤝 贡献欢迎提交 Issue 和 Pull Request 来帮助完善类型声明！ ### 贡献指南 1. Fork 本仓库 2. 创建特性分支：`git checkout -b feat/add-some-api` 3. 提交你的修改：`git commit -m 'feat: add some API declarations'` 4. 推送到分支：`git push origin feat/add-some-api` 5. 提交 Pull Request ### 问题反馈如果发现类型声明缺失、错误或与官方文档不一致，请在 [Issues](https://gitee.com/bonneau/wechat-and-bytedance-mini-gamet-tsapi/issues) 中提交反馈。 --- ## 📬 联系方式 - 📧 **邮箱**：`792010892@qq.com` - 🏠 **Gitee**：[https://gitee.com/bonneau](https://gitee.com/bonneau) 如有任何问题或建议，欢迎通过以上方式联系。 --- ## 📄 许可证 - **微信小游戏声明文件** (`lib.wx.api.d.ts`)：基于 Tencent 原始声明文件，沿用 MIT 许可证 - **抖音小游戏声明文件** (`lib.tt.api.d.ts`)：手动整理编写，MIT 许可证 - 本项目整体采用 **MIT 许可证** 详见各声明文件头部的版权声明。 --- ## ⭐ 支持项目如果这个项目帮助到了你，欢迎给个 Star ⭐，让更多开发者发现它！ ---

Made with ❤️ for the mini-game developer community