Etusivu Tutki Apua
Kirjaudu sisään
shisan
/
wxxyx-sdk
2
0
Fork 0
Tiedostot Ongelmat 0 Pull-pyynnöt 0 Wiki
Puu: ed6eddc391
Haarat Tagit
wxxyx-sdk
/
node_modules
/
minigame-api-typings
ith5cn ed6eddc391 first commit 1 kuukausi sitten
..
types ed6eddc391 first commit 1 kuukausi sitten
CHANGELOG.md ed6eddc391 first commit 1 kuukausi sitten
LICENSE ed6eddc391 first commit 1 kuukausi sitten
README-en.md ed6eddc391 first commit 1 kuukausi sitten
README.md ed6eddc391 first commit 1 kuukausi sitten
index.d.ts ed6eddc391 first commit 1 kuukausi sitten
package.json ed6eddc391 first commit 1 kuukausi sitten
typings.json ed6eddc391 first commit 1 kuukausi sitten

README-en.md

Wechat MiniGame API Typings

中文版本

Published on NPM MIT License GitHub Actions Test Status

Type definitions for APIs of Wechat Mini Game in TypeScript

Install

Install by NPM:

npm install minigame-api-typings

Manually import it after installed:

  • import 'minigame-api-typings';

Or specify types in typescript config:

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

Or reference by Triple-Slash Directives:

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

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.

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.