README-en.md

Wechat Mini Program API Typings

中文版本

Type definitions for APIs of Wechat Mini Program in TypeScript

Install

By standalone npm package

npm install miniprogram-api-typings

Manually import it after installed:

• import 'miniprogram-api-typings';

Or specify types in typescript config:

• Specify types: ["miniprogram-api-typings"] in tsconfig.json

Or reference by Triple-Slash Directives:

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

or:

By DefinitelyTyped

npm install @types/wechat-miniprogram

Changelog

See CHANGELOG.md (Chinese only)

Contribution

Definitions of Wechat APIs (lib.wx.api.d.ts) are auto-generated together with our documentations, therefore PRs including that file will not be merged. If you found some APIs defined wrongly, create an issue instead.

Both 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!

Contributors

• Baran
• MinLiang Zeng
• Garfield Lee
• Mr.Hope
• chs97
• Jelf
• xieyuhang
• 苏杰豪
• Yang Mingshan
• lvzl

Automated tests

We use tsd to check if this definition is working properly. All test cases are under folder test.

To perform an automated test, clone this repo, npm install --save-dev and npm test.

If you have test case that fails the test, an issue or PR will be great. Strong test case that passes are also welcomed.