@ray-js/api 1.6.23 → 1.6.24

package/@types/api-extend.d.ts

@@ -390,6 +390,39 @@ declare namespace ty {
    *@description 从本地缓存中异步获取指定 key 的内容
    *@error {6: 'The parameter format is incorrect'}*/
   export function getStorageSync(storageKeyBean?: StorageKeyBean): any
+
+  /**
+   * @description对页面内的唯一元素进行截图
+   * 基础库 2.23.0 开始支持
+   * 属性类型默认值必填说明
+   * selector string 否 元素唯一ID 或唯一 class , 默认: 截取当前页面
+   * backgroundColor string 否 背景颜色, 默认: jpeg #ffffff png 透明
+   * format string 否 图片格式, 默认: png 可选值: jpeg, png
+   * quality number 否 图片质量, 默认: 1 可选值: 0-1, 仅在 jpeg 格式下有效
+   * success function 否 接口调用成功的回调函数
+   * fail function 否 接口调用失败的回调函数
+   * complete function 否 接口调用结束的回调函数
+   * 注意: 可能由于页面样式的复杂度因素，截图结果可能会有所不同，如遇到此类问题，可尝试调整页面样式
+   */
+  export function snapshot(params: {
+    selector?: string
+    backgroundColor?: string
+    format?: string
+    quality?: number
+    success?: (params: {
+      /** 截图的临时文件路径 */
+      tempFilePath: string
+    }) => void
+    fail?: (params: {
+      errorMsg: string
+      errorCode: string | number
+      innerError?: {
+        errorCode: string | number
+        errorMsg: string
+      }
+    }) => void
+    complete?: () => void
+  }): void
 }
 
 declare namespace WechatMiniprogram {

package/lib/viewAPI.d.ts

@@ -13,3 +13,16 @@ export declare const createIpcPlayerContext: typeof ty.createIpcPlayerContext;
 export declare const createCameraContext: typeof ty.createCameraContext;
 export declare const createWebviewContext: typeof ty.createWebviewContext;
 export declare const connectSocket: typeof ty.connectSocket;
+/**
+ * @description 对页面内的唯一元素进行截图，注意: 可能由于页面样式的复杂度因素，截图结果可能会有所不同，如遇到此类问题，可尝试调整页面样式
+ * @since 基础库 2.23.0 @ray-js/ray 1.6.24
+ * @param {Object} params
+ * @property {string} params.selector 元素唯一ID 或唯一 class , 默认: 截取当前页面
+ * @property {string} params.backgroundColor 背景颜色, 默认: jpeg #ffffff png 透明
+ * @property {string} params.format 图片格式, 默认: png 可选值: jpeg, png
+ * @property {number} params.quality 图片质量, 默认: 1 可选值: 0-1, 仅在 jpeg 格式下有效
+ * @returns {Promise} 接口调用成功的回调函数
+ * @returns {Promise} 接口调用失败的回调函数
+ * @returns {Promise} 接口调用结束的回调函数
+ */
+export declare const snapshot: typeof ty.snapshot;

package/lib/viewAPI.js

@@ -15,4 +15,18 @@ export const createMapContext = factory('createMapContext');
 export const createIpcPlayerContext = factory('createIpcPlayerContext');
 export const createCameraContext = factory('createCameraContext');
 export const createWebviewContext = factory('createWebviewContext');
-export const connectSocket = factory('connectSocket');
+export const connectSocket = factory('connectSocket');
+
+/**
+ * @description 对页面内的唯一元素进行截图，注意: 可能由于页面样式的复杂度因素，截图结果可能会有所不同，如遇到此类问题，可尝试调整页面样式
+ * @since 基础库 2.23.0 @ray-js/ray 1.6.24
+ * @param {Object} params
+ * @property {string} params.selector 元素唯一ID 或唯一 class , 默认: 截取当前页面
+ * @property {string} params.backgroundColor 背景颜色, 默认: jpeg #ffffff png 透明
+ * @property {string} params.format 图片格式, 默认: png 可选值: jpeg, png
+ * @property {number} params.quality 图片质量, 默认: 1 可选值: 0-1, 仅在 jpeg 格式下有效
+ * @returns {Promise} 接口调用成功的回调函数
+ * @returns {Promise} 接口调用失败的回调函数
+ * @returns {Promise} 接口调用结束的回调函数
+ */
+export const snapshot = factory('snapshot');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/api",
-  "version": "1.6.23",
+  "version": "1.6.24",
   "description": "Ray universal api",
   "keywords": [
     "ray"
@@ -29,14 +29,14 @@
     "watch": "ray start --type=component"
   },
   "dependencies": {
-    "@ray-js/framework": "1.6.23",
-    "@ray-js/router": "1.6.23",
+    "@ray-js/framework": "1.6.24",
+    "@ray-js/router": "1.6.24",
     "@ray-js/wechat": "^0.2.19",
     "base64-browser": "^1.0.1",
     "query-string": "^7.1.3"
   },
   "devDependencies": {
-    "@ray-js/cli": "1.6.23",
+    "@ray-js/cli": "1.6.24",
     "art-template": "^4.13.2",
     "fs-extra": "^10.1.0",
     "miniprogram-api-typings": "^3.12.3",
@@ -46,5 +46,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.com"
   },
-  "gitHead": "cd98eb4ba0a92a48313b16b54e598c6f506a2fad"
+  "gitHead": "9d1aef04d0004295179fb3d9f011b0d3e4018f87"
 }