Git Product home page Git Product logo

api-typings's Introduction

微信小程序定义文件

English version

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

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

安装

通过 DefinitelyTyped

npm install @types/wechat-miniprogram

或:

通过独立 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" />

更新日志

参考 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。当然,能通过自动化测试的强有力的测试样例也是欢迎的。

api-typings's People

Contributors

baranwang avatar chs97 avatar dependabot[bot] avatar garfield550 avatar mister-hope avatar okxiaoliang4 avatar sgly avatar tttrz avatar wechat-miniprogram-admin avatar xieyhn avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.