|
|
@@ -510,6 +510,543 @@ declare var wx: {
|
|
|
complete?: Function;
|
|
|
}): void;
|
|
|
|
|
|
+ /**
|
|
|
+ * 创建一个 WebSocket 连接;一个微信小程序同时只能有一个 WebSocket 连接,如果当前已存在一个 WebSocket 连接,会自动关闭该连接,并重新创建一个 WebSocket 连接。
|
|
|
+ */
|
|
|
+ connectSocket(obj: {
|
|
|
+ /**
|
|
|
+ * 开发者服务器接口地址,必须是 wss 协议,且域名必须是后台配置的合法域名
|
|
|
+ */
|
|
|
+ url: string;
|
|
|
+ /**
|
|
|
+ * 请求的数据
|
|
|
+ */
|
|
|
+ data?: any;
|
|
|
+ /**
|
|
|
+ * HTTP Header , header 中不能设置 Referer
|
|
|
+ */
|
|
|
+ header?: any;
|
|
|
+ /**
|
|
|
+ * 默认是GET,有效值: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT
|
|
|
+ */
|
|
|
+ method?: string;
|
|
|
+ /**
|
|
|
+ * 子协议数组
|
|
|
+ */
|
|
|
+ protocols?: string[];
|
|
|
+ /**
|
|
|
+ * // generate time:2017-08-23 21:12:06
|
|
|
+// Type definitions for wx app
|
|
|
+// Definitions by: hellopao <https://github.com/hellopao/wx.d.ts>
|
|
|
+
|
|
|
+/************************************************
|
|
|
+* *
|
|
|
+* 微信小程序 API *
|
|
|
+* *
|
|
|
+************************************************/
|
|
|
+
|
|
|
+interface IAnimation {
|
|
|
+ /**
|
|
|
+ * 透明度,参数范围 0~1
|
|
|
+ */
|
|
|
+ opacity(value: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 颜色值
|
|
|
+ */
|
|
|
+ backgroundColor(color: string): IAnimation;
|
|
|
+ /**
|
|
|
+ * 长度值,如果传入 Number 则默认使用 px,可传入其他自定义单位的长度值
|
|
|
+ */
|
|
|
+ width(length: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 长度值,如果传入 Number 则默认使用 px,可传入其他自定义单位的长度值
|
|
|
+ */
|
|
|
+ height(length: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 长度值,如果传入 Number 则默认使用 px,可传入其他自定义单位的长度值
|
|
|
+ */
|
|
|
+ top(length: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 长度值,如果传入 Number 则默认使用 px,可传入其他自定义单位的长度值
|
|
|
+ */
|
|
|
+ left(length: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 长度值,如果传入 Number 则默认使用 px,可传入其他自定义单位的长度值
|
|
|
+ */
|
|
|
+ bottom(length: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 长度值,如果传入 Number 则默认使用 px,可传入其他自定义单位的长度值
|
|
|
+ */
|
|
|
+ right(length: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * deg的范围-180~180,从原点顺时针旋转一个deg角度
|
|
|
+ */
|
|
|
+ rotate(deg: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * deg的范围-180~180,在X轴旋转一个deg角度
|
|
|
+ */
|
|
|
+ rotateX(deg: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * deg的范围-180~180,在Y轴旋转一个deg角度
|
|
|
+ */
|
|
|
+ rotateY(deg: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * deg的范围-180~180,在Z轴旋转一个deg角度
|
|
|
+ */
|
|
|
+ rotateZ(deg: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 同transform-function rotate3d
|
|
|
+ */
|
|
|
+ rotate3d(x: number, y: number, z: number, deg: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 一个参数时,表示在X轴、Y轴同时缩放sx倍数;两个参数时表示在X轴缩放sx倍数,在Y轴缩放sy倍数
|
|
|
+ */
|
|
|
+ scale(sx: number, sy?: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 在X轴缩放sx倍数
|
|
|
+ */
|
|
|
+ scaleX(sx: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 在Y轴缩放sy倍数
|
|
|
+ */
|
|
|
+ scaleY(sy: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 在Z轴缩放sy倍数
|
|
|
+ */
|
|
|
+ scaleZ(sz: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 在X轴缩放sx倍数,在Y轴缩放sy倍数,在Z轴缩放sz倍数
|
|
|
+ */
|
|
|
+ scale3d(sx: number, sy: number, sz: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 一个参数时,表示在X轴偏移tx,单位px;两个参数时,表示在X轴偏移tx,在Y轴偏移ty,单位px。
|
|
|
+ */
|
|
|
+ translate(tx: number, ty?: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 在X轴偏移tx,单位px
|
|
|
+ */
|
|
|
+ translateX(tx: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 在Y轴偏移tx,单位px
|
|
|
+ */
|
|
|
+ translateY(tx: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 在Z轴偏移tx,单位px
|
|
|
+ */
|
|
|
+ translateZ(tx: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 在X轴偏移tx,在Y轴偏移ty,在Z轴偏移tz,单位px
|
|
|
+ */
|
|
|
+ translate3d(tx: number, ty: number, tz: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 参数范围-180~180;一个参数时,Y轴坐标不变,X轴坐标延顺时针倾斜ax度;两个参数时,分别在X轴倾斜ax度,在Y轴倾斜ay度
|
|
|
+ */
|
|
|
+ skew(ax: number, ay?: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 参数范围-180~180;Y轴坐标不变,X轴坐标延顺时针倾斜ax度
|
|
|
+ */
|
|
|
+ skewX(ax: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 参数范围-180~180;X轴坐标不变,Y轴坐标延顺时针倾斜ay度
|
|
|
+ */
|
|
|
+ skewY(ay: number): IAnimation;
|
|
|
+ /**
|
|
|
+ * 同transform-function matrix
|
|
|
+ */
|
|
|
+ matrix(a, b, c, d, tx, ty): IAnimation;
|
|
|
+ /**
|
|
|
+ * 同transform-function matrix3d
|
|
|
+ */
|
|
|
+ matrix3d(): IAnimation;
|
|
|
+}
|
|
|
+
|
|
|
+interface ICanvasContext {
|
|
|
+ /**
|
|
|
+ * 设置填充色, 如果没有设置 fillStyle,默认颜色为 black。
|
|
|
+ */
|
|
|
+ setFillStyle(color: string): void;
|
|
|
+ /**
|
|
|
+ * 设置边框颜色, 如果没有设置 fillStyle,默认颜色为 black。
|
|
|
+ */
|
|
|
+ setStrokeStyle(color: string): void;
|
|
|
+ /**
|
|
|
+ * 设置阴影
|
|
|
+ */
|
|
|
+ setShadow(offsetX: number, offsetY: number, blur: number, color: string): void;
|
|
|
+ /**
|
|
|
+ * 创建一个线性的渐变颜色。需要使用 addColorStop() 来指定渐变点,至少要两个。
|
|
|
+ */
|
|
|
+ createLinearGradient(x0: number, y0: number, x1: number, y1: number): void;
|
|
|
+ /**
|
|
|
+ * 创建一个圆形的渐变颜色。 起点在圆心,终点在圆环。 需要使用 addColorStop() 来指定渐变点,至少要两个。
|
|
|
+ */
|
|
|
+ createCircularGradient(x: number, y: number, r: number): void;
|
|
|
+ /**
|
|
|
+ * 创建一个颜色的渐变点。小于最小 stop 的部分会按最小 stop 的 color 来渲染,大于最大 stop 的部分会按最大 stop 的 color 来渲染。需要使用 addColorStop() 来指定渐变点,至少要两个。
|
|
|
+ */
|
|
|
+ addColorStop(stop: number, color: string): void;
|
|
|
+ /**
|
|
|
+ * 设置线条端点的样式
|
|
|
+ */
|
|
|
+ setLineCap(lineCap: 'butt' | 'round' | 'square'): void;
|
|
|
+ /**
|
|
|
+ * 设置两线相交处的样式
|
|
|
+ */
|
|
|
+ setLineJoin(lineJoin: 'bevel' | 'round' | 'miter'): void;
|
|
|
+ /**
|
|
|
+ * 设置线条宽度
|
|
|
+ */
|
|
|
+ setLineWidth(lineWidth: number): void;
|
|
|
+ /**
|
|
|
+ * 设置最大倾斜
|
|
|
+ */
|
|
|
+ setMiterLimit(miterLimit: number): void;
|
|
|
+ /**
|
|
|
+ * 添加一个矩形路径到当前路径。
|
|
|
+ */
|
|
|
+ rect(x: number, y: number, width: number, height: number): void;
|
|
|
+ /**
|
|
|
+ * 填充一个矩形。用 setFillStyle() 设置矩形的填充色,如果没设置默认是黑色。
|
|
|
+ */
|
|
|
+ fillRect(x: number, y: number, width: number, height: number): void;
|
|
|
+ /**
|
|
|
+ * 一个矩形(非填充)。用 setFillStroke() 设置矩形线条的颜色,如果没设置默认是黑色。
|
|
|
+ */
|
|
|
+ strokeRect(x: number, y: number, width: number, height: number): void;
|
|
|
+ /**
|
|
|
+ * 在给定的矩形区域内,清除画布上的像素
|
|
|
+ */
|
|
|
+ clearRect(x: number, y: number, width: number, height: number): void;
|
|
|
+ /**
|
|
|
+ * 对当前路径进行填充
|
|
|
+ */
|
|
|
+ fill(): void;
|
|
|
+ /**
|
|
|
+ * 对当前路径进行描边
|
|
|
+ */
|
|
|
+ stroke(): void;
|
|
|
+ /**
|
|
|
+ * 开始一个路径
|
|
|
+ */
|
|
|
+ beginPath(): void;
|
|
|
+ /**
|
|
|
+ * 关闭一个路径
|
|
|
+ */
|
|
|
+ closePath(): void;
|
|
|
+ /**
|
|
|
+ * 把路径移动到画布中的指定点,但不创建线条。
|
|
|
+ */
|
|
|
+ moveTo(x: number, y: number): void;
|
|
|
+ /**
|
|
|
+ * 添加一个新点,然后在画布中创建从该点到最后指定点的线条。
|
|
|
+ */
|
|
|
+ lineTo(x: number, y: number): void;
|
|
|
+ /**
|
|
|
+ * 添加一个弧形路径到当前路径,顺时针绘制。
|
|
|
+ */
|
|
|
+ arc(x: number, y: number, radius: number, startAngle: number, sweepAngle: number): void;
|
|
|
+ /**
|
|
|
+ * 创建二次方贝塞尔曲线
|
|
|
+ */
|
|
|
+ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void;
|
|
|
+ /**
|
|
|
+ * 创建三次方贝塞尔曲线
|
|
|
+ */
|
|
|
+ bezierCurveTo(cpx1: number, cpy1: number, cpx2: number, cpy2: number, x: number, y: number): void;
|
|
|
+ /**
|
|
|
+ * 对横纵坐标进行缩放
|
|
|
+ */
|
|
|
+ scale(scaleWidth: number/**横坐标缩放的倍数1 = 100%,0.5 = 50%,2 = 200%,依次类 */, scaleHeight: number/** 纵坐标轴缩放的倍数1 = 100%,0.5 = 50%,2 = 200%,依次类 */): void;
|
|
|
+ /**
|
|
|
+ * 对坐标轴进行顺时针旋转
|
|
|
+ */
|
|
|
+ rotate(deg: number/**degrees * Math.PI/180;degrees范围为0~360;旋转角度,以弧度计 */): void;
|
|
|
+ /**
|
|
|
+ * 对坐标原点进行缩放
|
|
|
+ */
|
|
|
+ translate(x: number/**水平坐标平移量 */, y: number/**竖直坐标平移量 */): void;
|
|
|
+ /**
|
|
|
+ * 在画布上绘制被填充的文本
|
|
|
+ */
|
|
|
+ fillText(text: string, x: number, y: number): void;
|
|
|
+ /**
|
|
|
+ * 设置字体大小
|
|
|
+ */
|
|
|
+ setFontSize(fontSize: number): void;
|
|
|
+ /**
|
|
|
+ * 在画布上绘制图像
|
|
|
+ */
|
|
|
+ drawImage(imageResource: string, x: number, y: number, width: number, height: number): void;
|
|
|
+ /**
|
|
|
+ * 设置全局画笔透明度。
|
|
|
+ */
|
|
|
+ setGlobalAlpha(alpha: number): void;
|
|
|
+ /**
|
|
|
+ * 保存当前坐标轴的缩放、旋转、平移信息
|
|
|
+ */
|
|
|
+ save(): void;
|
|
|
+ /**
|
|
|
+ * 恢复之前保存过的坐标轴的缩放、旋转、平移信息
|
|
|
+ */
|
|
|
+ restore(): void;
|
|
|
+ /**
|
|
|
+ * 进行绘图
|
|
|
+ */
|
|
|
+ draw(): void;
|
|
|
+}
|
|
|
+
|
|
|
+interface IAudioContext {
|
|
|
+ /**
|
|
|
+ * 播放
|
|
|
+ */
|
|
|
+ play: () => void;
|
|
|
+ /**
|
|
|
+ * 暂停
|
|
|
+ */
|
|
|
+ pause: () => void;
|
|
|
+ /**
|
|
|
+ * 跳转到指定位置,单位 s
|
|
|
+ */
|
|
|
+ seek: (position: number) => void;
|
|
|
+}
|
|
|
+
|
|
|
+interface IVideoContext {
|
|
|
+ /**
|
|
|
+ * 播放
|
|
|
+ */
|
|
|
+ play: () => void;
|
|
|
+ /**
|
|
|
+ * 暂停
|
|
|
+ */
|
|
|
+ pause: () => void;
|
|
|
+ /**
|
|
|
+ * 跳转到指定位置,单位 s
|
|
|
+ */
|
|
|
+ seek: (position: number) => void;
|
|
|
+ /**
|
|
|
+ * 发送弹幕,danmu 包含两个属性 text, color。
|
|
|
+ */
|
|
|
+ sendDanmu: (danmu: {text: string; color: string;}) => void;
|
|
|
+}
|
|
|
+
|
|
|
+interface IMapContext {
|
|
|
+ /**
|
|
|
+ * 获取当前地图中心的经纬度,返回的是 gcj02 坐标系,可以用于 wx.openLocation
|
|
|
+ */
|
|
|
+ getCenterLocation: (obj: {
|
|
|
+ /**
|
|
|
+ * 接口调用成功的回调函数 ,res = { longitude: "经度", latitude: "纬度"}
|
|
|
+ */
|
|
|
+ success?: (res: {longitude: string; latitude: string}) => void;
|
|
|
+ /**
|
|
|
+ * 接口调用失败的回调函数
|
|
|
+ */
|
|
|
+ fail?: () => void;
|
|
|
+ /**
|
|
|
+ * 接口调用结束的回调函数(调用成功、失败都会执行)
|
|
|
+ */
|
|
|
+ complete?: () => void;
|
|
|
+ }) => void;
|
|
|
+ /**
|
|
|
+ * 将地图中心移动到当前定位点,需要配合map组件的show-location使用
|
|
|
+ */
|
|
|
+ moveToLocation: () => void;
|
|
|
+}
|
|
|
+
|
|
|
+interface Application {
|
|
|
+ setData: (obj: any) => void;
|
|
|
+}
|
|
|
+
|
|
|
+interface AppConstructor {
|
|
|
+ new (): Application;
|
|
|
+ (opts: {
|
|
|
+ /**
|
|
|
+ * 生命周期函数--监听小程序初始化
|
|
|
+ */
|
|
|
+ onLaunch?: () => void;
|
|
|
+ /**
|
|
|
+ * 生命周期函数--监听小程序显示
|
|
|
+ */
|
|
|
+ onShow?: () => void;
|
|
|
+ /**
|
|
|
+ * 生命周期函数--监听小程序隐藏
|
|
|
+ */
|
|
|
+ onHide?: () => void;
|
|
|
+
|
|
|
+ [key: string]: any;
|
|
|
+ }): Application;
|
|
|
+}
|
|
|
+
|
|
|
+declare var App: AppConstructor;
|
|
|
+declare function getApp(): Application;
|
|
|
+
|
|
|
+declare function getCurrentPages(): Page[];
|
|
|
+
|
|
|
+interface Page {
|
|
|
+ setData: (obj: any) => void;
|
|
|
+}
|
|
|
+
|
|
|
+interface PageConstructor {
|
|
|
+ new (): Page;
|
|
|
+ (opts: {
|
|
|
+ /**
|
|
|
+ * 页面的初始数据
|
|
|
+ */
|
|
|
+ data?: any;
|
|
|
+ /**
|
|
|
+ * 页面的初始数据
|
|
|
+ */
|
|
|
+ onLoad?: () => void;
|
|
|
+ /**
|
|
|
+ * 生命周期函数--监听页面初次渲染完成
|
|
|
+ */
|
|
|
+ onReady?: () => void;
|
|
|
+ /**
|
|
|
+ * 生命周期函数--监听页面显示
|
|
|
+ */
|
|
|
+ onShow?: () => void;
|
|
|
+ /**
|
|
|
+ * 生命周期函数--监听页面隐藏
|
|
|
+ */
|
|
|
+ onHide?: () => void;
|
|
|
+ /**
|
|
|
+ * 生命周期函数--监听页面卸载
|
|
|
+ */
|
|
|
+ onUnload?: () => void;
|
|
|
+ /**
|
|
|
+ * 页面相关事件处理函数--监听用户下拉动作
|
|
|
+ */
|
|
|
+ onPullDownRefreash?: () => void;
|
|
|
+ /**
|
|
|
+ * 页面上拉触底事件的处理函数
|
|
|
+ */
|
|
|
+ onReachBottom?: () => void;
|
|
|
+ /**
|
|
|
+ * 用户点击右上角分享
|
|
|
+ */
|
|
|
+ onShareAppMessage?: () => {
|
|
|
+ /**
|
|
|
+ * 分享标题, 默认值当前小程序名称
|
|
|
+ */
|
|
|
+ title: string;
|
|
|
+ /**
|
|
|
+ * 分享描述, 默认值当前小程序名称
|
|
|
+ */
|
|
|
+ desc: string;
|
|
|
+ /**
|
|
|
+ * 分享路径 默认值当前页面 path ,必须是以 / 开头的完整路径
|
|
|
+ */
|
|
|
+ path: string;
|
|
|
+ };
|
|
|
+
|
|
|
+ [key: string]: any;
|
|
|
+ }): Page;
|
|
|
+}
|
|
|
+
|
|
|
+declare var Page: PageConstructor;
|
|
|
+
|
|
|
+declare var wx: {
|
|
|
+ // # 网络 #
|
|
|
+
|
|
|
+ request(obj: {
|
|
|
+ /**
|
|
|
+ * 开发者服务器接口地址
|
|
|
+ */
|
|
|
+ url: string;
|
|
|
+ /**
|
|
|
+ * 请求的参数
|
|
|
+ */
|
|
|
+ data?: any | string;
|
|
|
+ /**
|
|
|
+ * 设置请求的 header , header 中不能设置 Referer
|
|
|
+ */
|
|
|
+ header?: any;
|
|
|
+ /**
|
|
|
+ * 默认为 GET,有效值:OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT
|
|
|
+ */
|
|
|
+ method?: string;
|
|
|
+ /**
|
|
|
+ * 默认为 json。如果设置了 dataType 为 json,则会尝试对响应的数据做一次 JSON.parse
|
|
|
+ */
|
|
|
+ dataType?: string;
|
|
|
+ /**
|
|
|
+ * 收到开发者服务成功返回的回调函数,res = {data: '开发者服务器返回的内容'}
|
|
|
+ */
|
|
|
+ success?: Function;
|
|
|
+ /**
|
|
|
+ * 接口调用失败的回调函数
|
|
|
+ */
|
|
|
+ fail?: Function;
|
|
|
+ /**
|
|
|
+ * 接口调用结束的回调函数(调用成功、失败都会执行)
|
|
|
+ */
|
|
|
+ complete?: Function;
|
|
|
+ }): void;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 将本地资源上传到开发者服务器。如页面通过 wx.chooseImage 等接口获取到一个本地资源的临时文件路径后,可通过此接口将本地资源上传到指定服务器。客户端发起一个 HTTPS POST 请求,其中 content-type 为 multipart/form-data 。
|
|
|
+ */
|
|
|
+ uploadFile(obj: {
|
|
|
+ /**
|
|
|
+ * 开发者服务器 url
|
|
|
+ */
|
|
|
+ url: string;
|
|
|
+ /**
|
|
|
+ * 要上传文件资源的路径
|
|
|
+ */
|
|
|
+ filePath: string;
|
|
|
+ /**
|
|
|
+ * 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容
|
|
|
+ */
|
|
|
+ name: string;
|
|
|
+ /**
|
|
|
+ * HTTP 请求 Header , header 中不能设置 Referer
|
|
|
+ */
|
|
|
+ header?: any;
|
|
|
+ /**
|
|
|
+ * HTTP 请求中其他额外的 form data
|
|
|
+ */
|
|
|
+ formData?: any;
|
|
|
+ /**
|
|
|
+ * 接口调用成功的回调函数
|
|
|
+ */
|
|
|
+ success?: Function;
|
|
|
+ /**
|
|
|
+ * 接口调用失败的回调函数
|
|
|
+ */
|
|
|
+ fail?: Function;
|
|
|
+ /**
|
|
|
+ * 接口调用结束的回调函数(调用成功、失败都会执行)
|
|
|
+ */
|
|
|
+ complete?: Function;
|
|
|
+ }): void;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 下载文件资源到本地。客户端直接发起一个 HTTP GET 请求,返回文件的本地临时路径。
|
|
|
+ */
|
|
|
+ downloadFile(obj: {
|
|
|
+ /**
|
|
|
+ * 下载资源的 url
|
|
|
+ */
|
|
|
+ url: string;
|
|
|
+ /**
|
|
|
+ * HTTP 请求 Header
|
|
|
+ */
|
|
|
+ header?: any;
|
|
|
+ /**
|
|
|
+ * 下载成功后以 tempFilePath 的形式传给页面,res = {tempFilePath: '文件的临时路径'}
|
|
|
+ */
|
|
|
+ success?: Function;
|
|
|
+ /**
|
|
|
+ * 接口调用失败的回调函数
|
|
|
+ */
|
|
|
+ fail?: Function;
|
|
|
+ /**
|
|
|
+ * 接口调用结束的回调函数(调用成功、失败都会执行)
|
|
|
+ */
|
|
|
+ complete?: Function;
|
|
|
+ }): void;
|
|
|
+
|
|
|
/**
|
|
|
* 创建一个 WebSocket 连接;一个微信小程序同时只能有一个 WebSocket 连接,如果当前已存在一个 WebSocket 连接,会自动关闭该连接,并重新创建一个 WebSocket 连接。
|
|
|
*/
|