• Stars
    star
    673
  • Rank 66,752 (Top 2 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created almost 6 years ago
  • Updated 10 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Type definitions for APIs of Wechat Mini Program in TypeScript

微信小程序定义文件

English version

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

微信小程序 API 的 TypeScript 类型定义文件

安装

通过独立 npm 包

npm install miniprogram-api-typings

安装后手动导入:

  • import 'miniprogram-api-typings';

或者在 ts 配置中指定:

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

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

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

或:

通过 DefinitelyTyped

npm install @types/wechat-miniprogram

更新日志

参考 CHANGELOG.md

贡献

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

如果有针对页面(Page)、自定义组件(Component)等接口的 bug 和建议,欢迎 PR 或提一个 issue 给我们。非常感谢!

贡献者

测试

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

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

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

More Repositories

1

miniprogram-demo

微信小程序组件 / API / 云开发示例
JavaScript
6,576
star
2

minigame-unity-webgl-transform

Wechat Mini Game Unity engine adapter documents.
C
2,856
star
3

weui-miniprogram

小程序WeUI组件库
TypeScript
2,070
star
4

threejs-miniprogram

WeChat MiniProgram adapted version of Three.js
JavaScript
692
star
5

computed

小程序自定义组件 computed / watch 扩展
TypeScript
654
star
6

recycle-view

recycle-view: a wechat miniprogram custom component
JavaScript
620
star
7

miniprogram-simulate

小程序自定义组件测试工具集
JavaScript
487
star
8

kbone-ui

kbone-ui 是一套能同时支持 小程序(kbone) 和 vue 框架开发的多端 UI 库(PS:新版 kbone-ui 已出炉并迁移到 kbone 主仓库,此仓库仅做旧版维护之用)
Vue
439
star
9

sm-crypto

miniprogram sm crypto library
JavaScript
414
star
10

kbone-template-vue

a simple vue template for kbone
JavaScript
350
star
11

lottie-miniprogram

lottie for miniprogram
JavaScript
337
star
12

minigame-canvas-engine

轻量级canvas2d渲染引擎,开放数据域开发解决方案。
JavaScript
263
star
13

miniprogram-component-plus

JavaScript
253
star
14

miniprogram-custom-component

JavaScript
197
star
15

slide-view

weapp custom component -- slide-view
JavaScript
185
star
16

mobx-miniprogram-bindings

小程序的 MobX 绑定辅助库
TypeScript
175
star
17

glass-easel

Multiple-backend declarative component-based JavaScript framework
TypeScript
172
star
18

minigame-demo

微信小游戏组件 / API / 云开发示例
JavaScript
150
star
19

navigation-bar

weapp custom component -- navigation-bar
JavaScript
148
star
20

wxml-to-canvas

JavaScript
146
star
21

kbone-template-react

a simple react template for kbone
JavaScript
134
star
22

minigame-adaptor

C#
131
star
23

miniprogram-i18n

小程序国际化方案 / The internationalizational (i18n) library for wechat miniprogram
TypeScript
129
star
24

miniprogram-slim

JavaScript
123
star
25

h5-to-miniprogram

a simple tool for transforming h5 to miniprogam
JavaScript
113
star
26

minigame-api-typings

Type definitions for APIs of Wechat Mini Game in TypeScript
TypeScript
106
star
27

minigame-lockstep-demo

JavaScript
102
star
28

awesome-skyline

94
star
29

kbone-api

TypeScript
73
star
30

skylint

Skyline 小程序迁移工具. Migration assistant for Skyline miniapp.
TypeScript
69
star
31

miniprogram-cli

JavaScript
68
star
32

miniprogram-compat

微信小程序 js 执行环境的兼容信息
JavaScript
66
star
33

mpflow

TypeScript
61
star
34

miniprogram-api-promise

JavaScript
59
star
35

miniprogram-file-uploader

JavaScript
57
star
36

xr-frame-cli

Tools for xr-frame in wechat miniprogram.
TypeScript
50
star
37

kbone-template-kboneui

JavaScript
43
star
38

j-component

a mock minprogram component framework
JavaScript
43
star
39

miniprogram-gesture

微信小程序手势库
JavaScript
39
star
40

h5-to-miniprogram-demo

一个简单的使用 h5-to-miniprogram 工具进行 h5 页面转换成小程序的 demo
JavaScript
31
star
41

miniprogram-elder-transform

小程序适老化自动适配工具
TypeScript
31
star
42

miniprogram-barrage

JavaScript
23
star
43

minigame-tuanjie-transform-sdk

JavaScript
22
star
44

miniprogram-hooks

小程序自定义组件 hooks
JavaScript
20
star
45

miniprogram-cloudbase-meeting-demo

云开发直播运营活动 demo
JavaScript
17
star
46

kbone-template-preact

a simple preact template for kbone
JavaScript
12
star
47

miniprogram-game-quickstart

JavaScript
12
star
48

wechat-miniprogram.github.io

HTML
11
star
49

miniprogram-quickstart

JavaScript
10
star
50

gtktest

Flutter linux demo with webview.
C++
9
star
51

miniprogram-offline-demo

小程序弱网/离线 demo
JavaScript
9
star
52

miniprogram-data-panel

小程序数据面板组件
JavaScript
6
star
53

xnet-miniprogram

Python
6
star
54

router

JavaScript
4
star
55

babel-preset-miniprogram

微信小程序 babel 构建环境预设
JavaScript
2
star
56

minigame-playable

TypeScript
2
star
57

miniprogram-mock

mock api for miniprogram
JavaScript
1
star
58

mp-user-avatar

TypeScript
1
star