JesseWeb / api-typings

Type definitions for APIs of Wechat Mini Program in TypeScript

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

微信小程序定义文件-改

为了更完善的进行自动类型推断,推荐使用最新版TypeScript ( >= 3.4)

扩展完善

  • event 相关类型声明
  • console 类型定义(去除dom依赖)
  • wxs 类型定义
  • requirePlugin
  • App
    • app 事件参数自动推断
  • Page
    • this.setData() 无需感叹号,强类型验证
    • this.route 无感叹号
    • 补充 this.options
    • 补充 this.getTabBar() 支持 (含类型安全检查、泛型参数)
    • Page.onLoad 支持undefined
    • Page.onLoad / onPageScroll / onResize 等参数自动绑定
  • Component
    • properties 完整定义支持和类型绑定
    • data 绑定 properties 数据
    • observer/observers this 绑定(支持data/properties/methods调用)
    • lifetimes/pageLifetimes/relations/methods 完整this绑定(支持data/properties/methods调用)
    • setData 强类型校验和自动提示
    • this.getTabBar() 支持类型安全检查、泛型参数
  • Behavior (beta) Fixed 修复官方的错误定义
  • fix wx.AuthSetting 类型错误
  • fix chooseimage
  • fix choosefile
  • fix component 定义
  • fix page 定义错误
  • fix wx.OnStopCallbackResult (RecorderManager)
  • fix wx.Color 定义错误
  • fix 支持 canvasContext.setFillStyle() 传入 wx.CanvasGradient 类型
  • fix canvasContext.drawImage() 可选 3/5/9 个参数
  • fix canvasContext setTextAlign / setTextBaseline 约束
  • fix relativeToViewport()
  • fix setTimeout/setInterval rest 参数
  • fix innerAudio onerror/offerror callback

English version

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

安装

通过 npm 安装:

# 安装对应最新基础库的定义文件
npm install @dragongate/miniprogram-api-typings -D

或者通过版本号指定一个基础库版本:

# 安装对应基础库版本 2.4.1 的定义文件
npm install @dragongate/miniprogram-api-typings@version -D

版本

基础库版本 npm 版本 命令
v2.6.5 2.6.5-2 npm install miniprogram-api-typings@2.6.5-2
v2.4.2 2.4.2-2 npm install miniprogram-api-typings@2.4.2-2
v2.4.1 2.4.1 npm install miniprogram-api-typings@2.4.1
v2.4.0 2.4.0-1 npm install miniprogram-api-typings@2.4.0-1

贡献

PR Welcomed!

Supported by Microsoft.

About

Type definitions for APIs of Wechat Mini Program in TypeScript

License:MIT License


Languages

Language:TypeScript 97.2%Language:Shell 2.8%