{"id":13434775,"url":"https://github.com/wechat-miniprogram/api-typings","last_synced_at":"2025-05-14T21:06:03.946Z","repository":{"id":37733373,"uuid":"158225815","full_name":"wechat-miniprogram/api-typings","owner":"wechat-miniprogram","description":"Type definitions for APIs of Wechat Mini Program in TypeScript","archived":false,"fork":false,"pushed_at":"2025-04-24T10:20:08.000Z","size":1905,"stargazers_count":766,"open_issues_count":70,"forks_count":113,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-04-24T11:28:44.313Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wechat-miniprogram.png","metadata":{"files":{"readme":"README-en.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-11-19T13:16:19.000Z","updated_at":"2025-04-24T10:20:11.000Z","dependencies_parsed_at":"2023-02-09T11:32:04.719Z","dependency_job_id":"29539680-37bb-4af6-bf8d-6ba43440cc7f","html_url":"https://github.com/wechat-miniprogram/api-typings","commit_stats":{"total_commits":130,"total_committers":12,"mean_commits":"10.833333333333334","dds":0.3538461538461538,"last_synced_commit":"739a95c3a4919fc990a61161fbc15fb8874818cc"},"previous_names":[],"tags_count":89,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechat-miniprogram%2Fapi-typings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechat-miniprogram%2Fapi-typings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechat-miniprogram%2Fapi-typings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechat-miniprogram%2Fapi-typings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wechat-miniprogram","download_url":"https://codeload.github.com/wechat-miniprogram/api-typings/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254227611,"owners_count":22035669,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T03:00:22.669Z","updated_at":"2025-05-14T21:06:03.882Z","avatar_url":"https://github.com/wechat-miniprogram.png","language":"TypeScript","readme":"# Wechat Mini Program API Typings\n\n\u003e [中文版本](./README.md)\n\n[![Published on DefinitelyTyped](https://img.shields.io/npm/v/@types/wechat-miniprogram?label=%40types)](https://www.npmjs.com/package/@types/wechat-miniprogram)\n[![Published on NPM](https://img.shields.io/npm/v/miniprogram-api-typings.svg?style=flat)](https://www.npmjs.com/package/miniprogram-api-typings)\n[![MIT License](https://img.shields.io/github/license/wechat-miniprogram/api-typings.svg)](https://github.com/wechat-miniprogram/api-typings)\n[![GitHub Actions Test Status](https://github.com/wechat-miniprogram/api-typings/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/wechat-miniprogram/api-typings/actions/workflows/test.yml)\n\nType definitions for APIs of Wechat Mini Program in TypeScript\n\n## Install\n\n### By standalone npm package\n\n```bash\nnpm install miniprogram-api-typings\n```\n\nManually import it after installed:\n\n- `import 'miniprogram-api-typings';`\n\nOr specify types in typescript config:\n\n- Specify `types: [\"miniprogram-api-typings\"]` in `tsconfig.json`\n\nOr reference by [Triple-Slash Directives](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html):\n\n- `/// \u003creference path=\"node_modules/miniprogram-api-typings/index.d.ts\" /\u003e`\n\nor:\n\n### By DefinitelyTyped\n\n```bash\nnpm install @types/wechat-miniprogram\n```\n\n## Changelog\n\nSee [CHANGELOG.md](https://github.com/wechat-miniprogram/api-typings/blob/master/CHANGELOG.md) (Chinese only)\n\n## Contribution\n\nDefinitions of Wechat APIs (`lib.wx.api.d.ts`) are auto-generated together with our [documentations](https://developers.weixin.qq.com/miniprogram/en/dev/api/), therefore PRs including that file will __not__ be merged. If you found some APIs defined wrongly, create an issue instead.\n\nBoth PR and issue are welcomed for definitions of pages (`Page`), custom components (`Component`) and other else, since they are written manually. Help us improve this definition if you have any bug reports or suggestions! Thanks for contributing!\n\n### Contributors\n\n- [Baran](https://github.com/baranwang)\n- [MinLiang Zeng](https://github.com/zenml/)\n- [Garfield Lee](https://github.com/Garfield550)\n- [Mr.Hope](https://github.com/Mister-Hope)\n- [chs97](https://github.com/chs97)\n- [Jelf](https://github.com/okxiaoliang4)\n- [xieyuhang](https://github.com/haiya6)\n- [苏杰豪](https://github.com/Megasu)\n- [Yang Mingshan](https://github.com/yangmingshan)\n- [lvzl](https://github.com/lv-z-l)\n\n### Automated tests\n\nWe use [`tsd`](https://github.com/SamVerschueren/tsd) to check if this definition is working properly. All test cases are under folder `test`.\n\nTo perform an automated test, clone this repo, `npm install --save-dev` and `npm test`.\n\nIf you have test case that fails the test, an issue or PR will be great. Strong test case that passes are also welcomed.\n","funding_links":[],"categories":["HarmonyOS","TypeScript"],"sub_categories":["Windows Manager"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechat-miniprogram%2Fapi-typings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwechat-miniprogram%2Fapi-typings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechat-miniprogram%2Fapi-typings/lists"}