@dcloudio/uni-app-x 0.4.5 → 0.4.6

package/types/common.d.ts

@@ -0,0 +1,7 @@
+interface AnyObject {
+  [key: string]: any;
+}
+
+type KVInfer<T> = { [K in keyof T]: T[K] };
+
+type Void<T> = T | undefined | null;

package/types/index.d.ts

@@ -2,3 +2,6 @@
 /// <reference path='./vue/index.d.ts' />
 /// <reference path='./uni/index.d.ts' />
 /// <reference path='./uni-cloud/index.d.ts' />
+/// <reference path='./app.d.ts' />
+/// <reference path='./page.d.ts' />
+/// <reference path='./shims-vue.d.ts' />

package/types/native/AsyncApiResult.d.ts

@@ -1,5 +1,6 @@
 /**
  * @package io.dcloud.uniapp
+ * @autodoc false
  */
 interface AsyncApiResult {
   errMsg: string

package/types/native/CSSStyleDeclaration.d.ts

@@ -0,0 +1,20 @@
+/**
+ * CSSStyleDeclaration表示一个CSS 声明块对象，它是一个 CSS 属性键值对的集合，暴露样式信息和各种与样式相关的方法和属性。
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class CSSStyleDeclaration {
+
+/**
+ * 对CSS指定样式设置一个新值，如有此样式已存在则更新。
+ * @param name CSS样式名称
+ * @param value 要设置的新CSS样式值
+ */
+  setProperty(name: string, value: any|null): void
+
+/**
+ * 获取CSS指定的样式值，如果指定的样式不存在则返回null。
+ * @param property 要获取的CSS样式名称
+ */
+  getPropertyValue(property: string): any|null
+
+}

package/types/native/CustomEvent.d.ts

@@ -2,6 +2,7 @@
 
 /**
  * @package io.dcloud.uniapp.runtime
+ * @autodoc false
  */
 declare class CustomEventOptions<T>{
   detail: T
@@ -10,7 +11,9 @@ declare class CustomEventOptions<T>{
 
 /**
  * @package io.dcloud.uniapp.runtime
+ * @autodoc false
  */
 declare class CustomEvent<T> extends Event {
+  get detail(): T
   constructor (type: string, options: CustomEventOptions<T>)
 }

package/types/native/DOMRect.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 一个 DOMRect 代表一个矩形。
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class DOMRect {
+
+  /**
+   * 创建一个新的 DOMRect 对象
+   * @param x 矩形原点的x坐标
+   * @param y 矩形原点的y坐标
+   * @param width 矩形的宽
+   * @param height 矩形的高
+   */
+  constructor(x?: number, y?: number, width?: number, height?: number);
+
+  /**
+   * 矩形的宽
+   */
+  width: number
+
+  /**
+   * 矩形的高
+   */
+  height: number
+
+  /**
+   * 矩形原点的x坐标
+   */
+  x: number
+
+  /**
+   * 矩形原点的y坐标
+   */
+  y: number
+
+  /**
+   * 矩形的左坐标值
+   */
+  left: number
+
+  /**
+   * 矩形的右坐标值
+   */
+  right: number
+
+  /**
+   * 矩形的顶坐标值
+   */
+  top: number;
+
+  /**
+   * 矩形的底坐标值
+   */
+  bottom: number
+
+}

package/types/native/DrawableContext.d.ts

@@ -5,42 +5,133 @@
  */
 
 declare class DrawableContext {
+	/**
+	 * 设置字体大小，默认为`10px`
+	 */
 	font : string
+	/**
+	 * 设置填充颜色，默认为`#000 (黑色)`
+	 */
 	fillStyle : string
+	/**
+	 * 指定如何绘制每一条线条末端的属性，默认为`butt`
+	 */
 	lineCap : string
+	/**
+	 * 设置虚线偏移量
+	 */
 	lineDashOffset : number
+	/**
+	 * 设置 2 个长度不为 0 的线条相连部分如何连接在一起的属性，默认值`miter`
+	 */
 	lineJoin : string
+	/**
+	 * 设置线条的宽度，默认为`1px`
+	 */
 	lineWidth : number
+	/**
+	 * 设置边框的颜色，默认为`#000 (黑色)`
+	 */
 	strokeStyle : string
+	/**
+	 * 设置文本的对齐方式，默认为`left`
+	 */
 	textAlign : string
-
+	/**
+	 * 创建一个新的空路径
+	 */
 	beginPath() : void
 
+	/**
+	 * 绘制一段弧线
+	 * @param {number} x 圆心的X轴坐标
+	 * @param {number} y 圆心的Y轴坐标
+	 * @param {number} radius 圆弧的半径
+	 * @param {number} startAngle 圆弧的起始点，x 轴方向开始计算，单位为弧度
+	 * @param {number} endAngle 圆弧的终点，单位为弧度
+	 * @param {number} anticlockwise 圆弧绘制方向，true：逆时针绘制，false：顺时针绘制。默认为true。可选
+	 */
 	arc(x : number, y : number, radius : number, startAngle : number, endAngle : number, anticlockwise ?: boolean) : void
 
+	/**
+	 * 将一个新的路径的起始点移动到 (x，y) 坐标
+	 * @param {number} x 点的X轴坐标
+	 * @param {number} y 点的Y轴坐标
+	 */
 	moveTo(x : number, y : number) : void
-
+	
+	/**
+	 * 创建一个矩形路径
+	 * @param {number} x 矩形起点的X轴坐标
+	 * @param {number} y 矩形起点的Y轴坐标
+	 * @param {number} width 矩形宽度
+	 * @param {number} height 矩形高度
+	 */
 	rect(x : number, y : number, width : number, height : number) : void
 
+	/**
+	 * 将路径的最后一个点连接到 (x，y) 坐标
+	 * @param {number} x 线终点的X轴坐标
+	 * @param {number} y 线终点的Y轴坐标
+	 */
 	lineTo(x : number, y : number) : void
-
+	/**
+	 * 闭合路径，将最后一个点与起点连接起来。如果图形已经封闭，或者只有一个点，那么此方法不会产生任何效果。
+	 */
 	closePath() : void
-
+	/**
+	 * 绘制当前或已经存在的路径的边框。
+	 */
 	stroke() : void
-
+	/**
+	 * 绘制一个矩形框
+	 * @param {number} x 矩形起点的X轴坐标
+	 * @param {number} y 矩形起点的Y轴坐标
+	 * @param {number} width 矩形宽度
+	 * @param {number} height 矩形高度
+	 */
 	strokeRect(x : number, y : number, width : number, height : number) : void
-
+	/**
+	 * 绘制空心字符
+	 * @param {string} text 要绘制的字符
+	 * @param {number} x 字符开始绘制的X轴坐标
+	 * @param {number} y 字符开始绘制的Y轴坐标
+	 */
 	strokeText(text : string, x : number, y : number) : void
 
+	/**
+	 * 填充当前或已存在的路径
+	 * @param {string} fillRule 填充规则，默认为`nonzero`。可选
+	 */
 	fill(fillRule ?: string) : void
-
+	
+	/**
+	 * 绘制一个实心矩形
+	 * @param {number} x 矩形起点的X轴坐标
+	 * @param {number} y 矩形起点的Y轴坐标
+	 * @param {number} width 矩形宽度
+	 * @param {number} height 矩形高度
+	 */
 	fillRect(x : number, y : number, width : number, height : number) : void
-
+	
+	/**
+	 * 绘制实心字符
+	 * @param {string} text 要绘制的字符
+	 * @param {number} x 字符开始绘制的X轴坐标
+	 * @param {number} y 字符开始绘制的Y轴坐标
+	 */
 	fillText(text : string, x : number, y : number) : void
-
+	/**
+	 * 清空绘制数据
+	 */
 	reset() : void
-
+	/**
+	 * 将所有绘制内容更新到画布上
+	 */
 	update() : void
-
+	/**
+	 * 设置虚线样式
+	 * @param {Array<number>} segments 一组描述交替绘制线段和间距长度的数字。
+	 */
 	setLineDash(segments : Array<number>) : void
 }

package/types/native/Event.d.ts

@@ -4,14 +4,29 @@
  * @package io.dcloud.uniapp.runtime
  */
 declare class Event {
-  type: string
-  target: INode
-  currentTarget: INode
-  timeStamp: number
-
-  constructor (type: string)
-
-  stopPropagation(): void
-
-  preventDefault(): void
+	constructor (type: string)
+    /**
+     * 事件类型
+     */
+    type: string
+    /**
+     * 触发事件的组件
+     */
+    target: INode
+    /**
+     * 当前组件
+     */
+    currentTarget: INode
+    /**
+     * 事件发生时的时间戳
+     */
+    timeStamp: number
+    /**
+     * 阻止当前事件的进一步传播
+     */
+    stopPropagation(): void
+    /**
+     * 阻止当前事件的默认行为
+     */
+    preventDefault(): void
 }

package/types/native/IApp.d.ts

@@ -2,6 +2,7 @@
 
 /**
  * @package io.dcloud.uniapp.runtime
+ * @autodoc false
  */
 declare class IApp {
   appid: string

package/types/native/IDocument.d.ts

@@ -4,6 +4,7 @@
 
 /**
  * @package io.dcloud.uniapp.runtime
+ * @autodoc false
  */
 interface IDocument extends INode {
   body: INode

package/types/native/INode.d.ts

@@ -4,47 +4,178 @@
  * @package io.dcloud.uniapp.runtime
  */
 interface INode {
+  /**
+   * 获取当前节点的的第一个子节点，如果节点是无子节点，则返回 null。
+   */
   firstChild: INode | null
+
+  /**
+   * 获取当前节点的最后一个子节点，如果没有子节点，则返回 null。
+   */
   lastChild: INode | null
+
+  /**
+   * 获取当前节点在 DOM 树中的父节点，如果没有父节点（如未添加到DOM树中），则返回null。
+   */
   parentNode: INode | null
+
+  /**
+   * 获取当前节点的前一个同级节点，没有则返回null。
+   */
   previousSibling: INode | null
+
+  /**
+   * 获取在 DOM 树中紧跟在其后面的同级节点，如果指定的节点为最后一个节点，则返回 null。
+   */
   nextSibling: INode | null
+
+  /**
+   * 获取在 DOM 树中紧跟在其后面的同级节点，如果指定的节点为最后一个节点，则返回 null。
+   * @autodoc false
+   */
   nextElementSibling: INode | null
+
+  /**
+   * 获取当前节点包含的子节点的集合
+   */
   childNodes: INode[]
+
+  /**
+   * 获取当前节点的标签名
+   * @autodoc false
+   */
   tagName: string
+
+  /**
+   * 获取当前节点的节点名称
+   */
   nodeName: string
+
+  /**
+   * 获取当前节点的扩展参数
+   * @autodoc false
+   */
   ext: Map<string, any>
+
+  /**
+   * 获取节点上自定义数据属性（data-*）的集合
+   */
   dataset: Map<string, any | null>
+
+  /**
+   * 获取节点上所有属性节点的集合
+   */
   attributes: Map<string, any | null>
+
+  /**
+   * 获取节点的CSS样式对象
+   */
   style: CSSStyleDeclaration
 
+  /**
+   * 表示节点的滚动视图高度
+   */
+  scrollHeight: number
+
+  /**
+    * 表示该节点横向滚动条距离最左的位移。
+    */
+  scrollLeft: number
+
+  /**
+   * 表示该节点纵向滚动条距离
+   */
+  scrollTop: number
+
+  /**
+   * 表示节点的滚动视图宽度
+   */
+  scrollWidth: Float
+
+  /**
+   * 获取节点标识。
+   * @autoDoc false
+   */
   getNodeId(): string
 
+  /**
+   * 将一个节点添加到指定父节点的子节点列表的末尾处。如果将被插入的节点已经存在于当前文档的文档树中，那么将会它从原先的位置移动到新的位置。
+   */
   appendChild(aChild: INode): void
 
-  insertBefore(newChild: INode): void
-
+  /**
+   * 在参考节点之前插入一个拥有指定父节点的子节点。如果给定的子节点是对文档中现有节点的引用，insertBefore() 会将其从当前位置移动到新位置。
+   */
   insertBefore(newChild: INode, refChild: INode): void
 
-  setAttribute(key: string, value: unknown): void
+  /**
+   * 设置指定节点上的某个属性值。如果设置的属性已经存在，则更新该属性值；否则使用指定的名称和值添加一个新的属性。
+   */
+  setAttribute(key: string, value: any | null): void
 
-  getAttribute(key: string): unknown
+  /**
+   * 获取节点指定的属性值，如果指定的属性不存在则返回null。
+   */
+  getAttribute(key: string): any | null
 
+  /**
+   * 返回改节点是否包含有指定的属性，属性存在则返回true，否则返回false。
+   */
   hasAttribute(key: string): boolean
 
+  /**
+   * 从节点中删除一个属性，如果指定的属性不存在，则不做任何操作，也不会产生错误。
+   */
   removeAttribute(key: string): void
 
+  /**
+   * 更新节点的样式。
+   * @autodoc false
+   */
   updateStyle(map: Map<string, any>): void
 
+  /**
+   * 获取节点的大小及其相对于窗口的位置信息。
+   */
   getBoundingClientRect(): DOMRect
 
-  addEventListener(type: string, callback: (event: Event) => void): void
+  /**
+   * 获取组件的绘制对象，仅uvue页面中的 view 组件支持，其它组件不支持则返回null。
+   */
+  getDrawableContext(): DrawableContext | null
+
+  /**
+   * 将指定的监听器注册到节点对象上，当该对象触发指定的事件时，指定的回调函数就会被执行。
+   */
+  addEventListener<T extends Event, R>(type: string, callback: (event: T) => R): void
 
+  /**
+   * 删除使用 addEventListener 方法添加的事件监听器。
+   */
   removeEventListener(type: string): void
 
+  /**
+   * 从节点中删除一个子节点，返回删除的节点。
+   */
   removeChild(aChild: INode): INode
 
+  /**
+   * 把节点对象从它所属的 DOM 树中删除。
+   */
   remove(): void
 
+  /**
+   * 向一个指定的事件目标派发一个 Event，并以合适的顺序（同步地）调用此事件的监听器回调函数。
+   */
   dispatchEvent(type: string, value: Event): void
+
+  /**
+   * 使界面滚动到给定元素的指定坐标位置
+   */
+  scrollTo(x: number, y: number): void
+
+  /**
+   * 使得元素滚动一段特定距离
+   */
+  scrollBy(x: number, y: number): void
 }

package/types/native/IPage.d.ts

@@ -3,6 +3,7 @@
 
 /**
  * @package io.dcloud.uniapp.runtime
+ * @autodoc false
  */
 interface IPage extends INode {
   pageId: string

package/types/native/IPageManager.d.ts

@@ -2,6 +2,7 @@
 
 /**
  * @package io.dcloud.uniapp.runtime
+ * @autodoc false
  */
 declare class IPageManager {
   createPage(

package/types/native/ITabsNode.d.ts

@@ -2,6 +2,7 @@
 
 /**
  * @package io.dcloud.uniapp.runtime
+ * @autodoc false
  */
 interface ITabsNode extends INode {
   appendItem(pageId: string): void

package/types/native/IWebViewNode.d.ts

@@ -0,0 +1,28 @@
+/// <reference path='./INode.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ * @autodoc false
+ */
+interface IWebViewNode extends INode {
+  /**
+   * 后退
+   */
+  back(): void
+  /**
+   * 前进
+   */
+  forward(): void
+  /**
+   * 重新加载
+   */
+  reload(): void
+  /**
+   * 停止加载
+   */
+  stop(): void
+  /**
+   * 原生和WebView通信（执行JS脚本）
+   */
+  evalJS(js: string): void
+}

package/types/native/ImageErrorEvent.d.ts

@@ -0,0 +1,13 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class ImageErrorEvent extends Event {
+  detail: {
+    /**
+     * 错误信息
+     */
+    errMsg: string
+  }
+}

package/types/native/ImageLoadEvent.d.ts

@@ -0,0 +1,17 @@
+/// <reference path='./Event.d.ts' />
+
+/**
+ * @package io.dcloud.uniapp.runtime
+ */
+declare class ImageLoadEvent extends Event {
+  detail: {
+    /**
+     * 图片宽度
+     */
+    width: number,
+    /**
+     * 图片高度
+     */
+    height: number
+  }
+}

package/types/native/MouseEvent.d.ts

@@ -4,23 +4,48 @@
  * @package io.dcloud.uniapp.runtime
  */
 declare class MouseEvent extends Event {
-  x: number
-  y: number
-  clientX: number
-  clientY: number
-  pageX: number
-  pageY: number
-  screenX: number
-  screenY: number
-  constructor (
-    type: string,
-    x: number,
-    y: number,
-    clientX: number,
-    clientY: number,
-    pageX: number,
-    pageY: number,
-    screenX: number,
-    screenY: number
-  )
+    /**
+     * 相对于页面可显示区域左边的距离
+     */
+    clientX : number
+    /**
+     * 相对于页面可显示区域顶部的距离
+     */
+    clientY : number
+    /**
+     * 相对于页面可显示区域左边的距离，同`clientX`
+     */
+    x : number
+    /**
+     * 相对于页面可显示区域顶部的距离，同`clientY`
+     */
+    y : number
+    /**
+    相对于文档左边的距离
+     */
+    pageX : number
+    /**
+     * 相对于文档顶部的距离
+     */
+    pageY : number
+    /**
+     * 相对于屏幕左边距离
+     */
+    screenX : number
+    /**
+     * 相对于屏幕顶部的距离
+     */
+    screenY : number
+	
+	constructor (
+	  type: string,
+	  x: number,
+	  y: number,
+	  clientX: number,
+	  clientY: number,
+	  pageX: number,
+	  pageY: number,
+	  screenX: number,
+	  screenY: number
+	)
 }

package/types/native/NodeData.d.ts

@@ -1,5 +1,6 @@
 /**
  * @package io.dcloud.uniapp.native.node
+ * @autodoc false
  */
 declare class NodeData {
   id: string

package/types/native/PageEvent.d.ts

@@ -2,6 +2,7 @@
 
 /**
  * @package io.dcloud.uniapp.runtime
+ * @autodoc false
  */
 declare class PageEvent extends Event {
 }

package/types/native/PageScrollEvent.d.ts

@@ -4,5 +4,8 @@
  * @package io.dcloud.uniapp.runtime
  */
 declare class PageScrollEvent extends PageEvent {
+	/**
+	 * 竖向滚动的距离
+	 */
   scrollTop: number
 }