@tarojs/taro-h5 3.3.20 → 3.4.0-beta.3

package/dist/api/ad/index.js

@@ -1,3 +1,4 @@
 import { temporarilyNotSupport } from '../utils';
+// 广告
 export const createRewardedVideoAd = temporarilyNotSupport('createRewardedVideoAd');
 export const createInterstitialAd = temporarilyNotSupport('createInterstitialAd');

package/dist/api/ai/facial.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// 人脸识别
 export const stopFaceDetect = temporarilyNotSupport('stopFaceDetect');
 export const initFaceDetect = temporarilyNotSupport('initFaceDetect');
 export const faceDetect = temporarilyNotSupport('faceDetect');

package/dist/api/ai/visual.js

@@ -1,2 +1,3 @@
 import { temporarilyNotSupport } from '../utils';
+// 视觉算法
 export const createVKSession = temporarilyNotSupport('createVKSession');

package/dist/api/alipay/index.js

@@ -1,2 +1,3 @@
 import { temporarilyNotSupport } from '../utils';
+// AliPay
 export const getOpenUserInfo = temporarilyNotSupport('getOpenUserInfo');

package/dist/api/base/crypto.js

@@ -1,2 +1,3 @@
 import { temporarilyNotSupport } from '../utils';
+// 加密
 export const getUserCryptoManager = temporarilyNotSupport('getUserCryptoManager');

package/dist/api/base/index.js

@@ -1,5 +1,6 @@
 import { fromByteArray, toByteArray } from 'base64-js';
 import { temporarilyNotSupport } from '../utils';
+// TODO env 环境变量
 export const canIUse = temporarilyNotSupport('canIUse');
 export function arrayBufferToBase64(arrayBuffer) {
     return fromByteArray(arrayBuffer);

package/dist/api/base/performance.js

@@ -1,3 +1,4 @@
 import { temporarilyNotSupport } from '../utils';
+// 性能
 export const reportPerformance = temporarilyNotSupport('reportPerformance');
 export const getPerformance = temporarilyNotSupport('getPerformance');

package/dist/api/base/system/info.js

@@ -17,6 +17,7 @@ export const getSystemInfoSync = () => {
         language: navigator.language,
         fontSizeSetting: NaN,
         SDKVersion: '',
+        // TODO
         albumAuthorized: false,
         benchmarkLevel: 0,
         bluetoothEnabled: false,

package/dist/api/base/system/network.js

@@ -1,6 +1,7 @@
 import { MethodHandler } from '../../utils/handler';
 import { temporarilyNotSupport } from '../../utils';
 function getConnection() {
+    // @ts-ignore
     return navigator.connection || navigator.mozConnection || navigator.webkitConnection || navigator.msConnection;
 }
 export const getNetworkType = (options = {}) => {
@@ -8,28 +9,38 @@ export const getNetworkType = (options = {}) => {
     const { success, fail, complete } = options;
     const handle = new MethodHandler({ name: 'getNetworkType', success, fail, complete });
     let networkType = 'unknown';
+    // 浏览器不支持获取网络状态
     if (!connection) {
         return handle.success({ networkType });
     }
+    // Supports only the navigator.connection.type value which doesn't match the latest spec.
+    // https://www.davidbcalhoun.com/2010/using-navigator-connection-android/
     if (!isNaN(Number(connection.type))) {
         switch (connection.type) {
+            // @ts-ignore
             case connection.WIFI:
                 networkType = 'wifi';
                 break;
+            // @ts-ignore
             case connection.CELL_3G:
                 networkType = '3g';
                 break;
+            // @ts-ignore
             case connection.CELL_2G:
                 networkType = '2g';
                 break;
             default:
+                // ETHERNET, UNKNOWN
                 networkType = 'unknown';
         }
     }
     else if (connection.type) {
-        networkType = connection.type;
+        // @ts-ignore
+        networkType = connection.type; // Only supports the type value.
+        // @ts-ignore
     }
     else if (connection.effectiveType) {
+        // @ts-ignore
         networkType = connection.effectiveType;
     }
     return handle.success({ networkType });

package/dist/api/base/update.js

@@ -1,3 +1,4 @@
 import { temporarilyNotSupport } from '../utils';
+// 更新
 export const updateWeChatApp = temporarilyNotSupport('updateWeChatApp');
 export const getUpdateManager = temporarilyNotSupport('getUpdateManager');

package/dist/api/base/weapp/app-event.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../../utils';
+// 应用级事件
 export const onUnhandledRejection = temporarilyNotSupport('onUnhandledRejection');
 export const onThemeChange = temporarilyNotSupport('onThemeChange');
 export const onPageNotFound = temporarilyNotSupport('onPageNotFound');

package/dist/api/base/weapp/life-cycle.js

@@ -1,3 +1,4 @@
 import { temporarilyNotSupport } from '../../utils';
+// 生命周期
 export const getLaunchOptionsSync = temporarilyNotSupport('getLaunchOptionsSync');
 export const getEnterOptionsSync = temporarilyNotSupport('getEnterOptionsSync');

package/dist/api/canvas/CanvasContext.js

@@ -53,6 +53,7 @@ export class CanvasContext {
     get shadowOffsetY() { return this.ctx.shadowOffsetY; }
     set strokeStyle(e) { this.enqueueActions(() => { this.ctx.strokeStyle = e; }); }
     get strokeStyle() { return this.ctx.strokeStyle; }
+    /** 小程序文档中不包括 ↓↓↓ */
     set textAlign(e) { this.ctx.textAlign = e; }
     get textAlign() { return this.ctx.textAlign; }
     set textBaseline(e) { this.ctx.textBaseline = e; }
@@ -65,6 +66,7 @@ export class CanvasContext {
     get imageSmoothingQuality() { return this.ctx.imageSmoothingQuality; }
     set filter(e) { this.enqueueActions(() => { this.ctx.filter = e; }); }
     get filter() { return this.ctx.filter; }
+    /** 小程序文档中不包括 ↑↑↑ */
     arc(...args) { return this.enqueueActions(this.ctx.arc, ...args); }
     arcTo(...args) { return this.enqueueActions(this.ctx.arcTo, ...args); }
     beginPath(...args) { return this.enqueueActions(this.ctx.beginPath, ...args); }
@@ -75,11 +77,16 @@ export class CanvasContext {
     createPattern(image, repetition) {
         return this.createPattern(image, repetition);
     }
+    /**
+     * 将之前在绘图上下文中的描述（路径、变形、样式）画到 canvas 中。
+     * @todo 每次 draw 都会读取 width 和 height
+     */
     async draw(reserve, callback) {
         try {
             if (!reserve) {
                 this.ctx.clearRect(0, 0, this.canvas.width, this.canvas.height);
             }
+            // 部分 action 是异步的
             for (const { func, args } of this.actions) {
                 await func.apply(this.ctx, args);
             }
@@ -87,6 +94,7 @@ export class CanvasContext {
             callback && callback();
         }
         catch (e) {
+            /* eslint-disable no-throw-literal */
             throw {
                 errMsg: e.message
             };
@@ -94,6 +102,7 @@ export class CanvasContext {
     }
     drawImage(imageResource, ...extra) {
         this.enqueueActions(() => {
+            // 需要转换为 Image
             if (typeof imageResource === 'string') {
                 const img = new Image();
                 img.src = imageResource;

package/dist/api/canvas/canvasGetImageData.js

@@ -1,11 +1,15 @@
 import { MethodHandler } from '../utils/handler';
 import { findDOM } from '../utils';
+/**
+ * 获取 canvas 区域隐含的像素数据。
+ */
 export const canvasGetImageData = ({ canvasId, success, fail, complete, x, y, width, height }, inst) => {
     const handle = new MethodHandler({ name: 'canvasGetImageData', success, fail, complete });
     const el = findDOM(inst);
     const canvas = el === null || el === void 0 ? void 0 : el.querySelector(`canvas[canvas-id="${canvasId}"]`);
     try {
         const ctx = canvas === null || canvas === void 0 ? void 0 : canvas.getContext('2d');
+        // TODO ImageData => Uint8ClampedArray
         const data = ctx === null || ctx === void 0 ? void 0 : ctx.getImageData(x, y, width, height);
         return handle.success({
             width,

package/dist/api/canvas/canvasPutImageData.js

@@ -1,11 +1,16 @@
 import { MethodHandler } from '../utils/handler';
 import { findDOM } from '../utils';
+/**
+ * 将像素数据绘制到画布。在自定义组件下，第二个参数传入自定义组件实例 this，以操作组件内 <canvas> 组件
+ * @todo 暂未支持尺寸相关功能
+ */
 export const canvasPutImageData = ({ canvasId, data, x, y, success, fail, complete }, inst) => {
     const handle = new MethodHandler({ name: 'canvasPutImageData', success, fail, complete });
     const el = findDOM(inst);
     const canvas = el === null || el === void 0 ? void 0 : el.querySelector(`canvas[canvas-id="${canvasId}"]`);
     try {
         const ctx = canvas.getContext('2d');
+        // TODO Uint8ClampedArray => ImageData
         ctx === null || ctx === void 0 ? void 0 : ctx.putImageData(data, x, y);
         return handle.success();
     }

package/dist/api/canvas/canvasToTempFilePath.js

@@ -1,5 +1,9 @@
 import { findDOM } from '../utils';
 import { MethodHandler } from '../utils/handler';
+/**
+ * 把当前画布指定区域的内容导出生成指定大小的图片。在 draw() 回调里调用该方法才能保证图片导出成功。
+ * @todo 暂未支持尺寸相关功能
+ */
 export const canvasToTempFilePath = ({ canvasId, fileType, quality, success, fail, complete }, inst) => {
     const handle = new MethodHandler({ name: 'canvasToTempFilePath', success, fail, complete });
     const el = findDOM(inst);

package/dist/api/canvas/createCanvasContext.js

@@ -1,5 +1,8 @@
 import { findDOM } from '../utils';
 import { CanvasContext } from './CanvasContext';
+/**
+ * 创建 canvas 的绘图上下文 CanvasContext 对象
+ */
 export const createCanvasContext = (canvasId, inst) => {
     const el = findDOM(inst);
     const canvas = el === null || el === void 0 ? void 0 : el.querySelector(`canvas[canvas-id="${canvasId}"]`);

package/dist/api/canvas/index.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// 画布
 export const createOffscreenCanvas = temporarilyNotSupport('createOffscreenCanvas');
 export * from './createCanvasContext';
 export * from './canvasToTempFilePath';

package/dist/api/cloud/index.js

@@ -4,10 +4,13 @@ export class cloud {
         this.init = temporarilyNotSupport('cloud.init');
         this.CloudID = temporarilyNotSupport('cloud.CloudID');
         this.callFunction = temporarilyNotSupport('cloud.callFunction');
+        // @ts-ignore
         this.uploadFile = temporarilyNotSupport('cloud.uploadFile');
+        // @ts-ignore
         this.downloadFile = temporarilyNotSupport('cloud.downloadFile');
         this.getTempFileURL = temporarilyNotSupport('cloud.getTempFileURL');
         this.deleteFile = temporarilyNotSupport('cloud.deleteFile');
+        // @ts-ignore
         this.database = temporarilyNotSupport('cloud.database');
         this.callContainer = temporarilyNotSupport('cloud.callContainer');
     }

package/dist/api/device/accelerometer.js

@@ -1,6 +1,9 @@
 import { CallbackManager, MethodHandler } from '../utils/handler';
 const callbackManager = new CallbackManager();
 let devicemotionListener;
+/**
+ * 停止监听加速度数据。
+ */
 export const stopAccelerometer = ({ success, fail, complete } = {}) => {
     const res = {};
     const handle = new MethodHandler({ name: 'stopAccelerometer', success, fail, complete });
@@ -43,6 +46,9 @@ const getDevicemotionListener = interval => {
         timer = setTimeout(() => { lock = false; }, interval);
     };
 };
+/**
+ * 开始监听加速度数据。
+ */
 export const startAccelerometer = ({ interval = 'normal', success, fail, complete } = {}) => {
     const handle = new MethodHandler({ name: 'startAccelerometer', success, fail, complete });
     try {
@@ -63,9 +69,15 @@ export const startAccelerometer = ({ interval = 'normal', success, fail, complet
         return handle.fail({ errMsg: e.message });
     }
 };
+/**
+ * 监听加速度数据事件。频率根据 Taro.startAccelerometer() 的 interval 参数。可使用 Taro.stopAccelerometer() 停止监听。
+ */
 export const onAccelerometerChange = callback => {
     callbackManager.add(callback);
 };
+/**
+ * 取消监听加速度数据事件，参数为空，则取消所有的事件监听
+ */
 export const offAccelerometerChange = callback => {
     callbackManager.remove(callback);
 };

package/dist/api/device/accessibility.js

@@ -1,2 +1,3 @@
 import { temporarilyNotSupport } from '../utils';
+// 无障碍
 export const checkIsOpenAccessibility = temporarilyNotSupport('checkIsOpenAccessibility');

package/dist/api/device/battery.js

@@ -1,3 +1,4 @@
 import { temporarilyNotSupport } from '../utils';
+// 电量
 export const getBatteryInfoSync = temporarilyNotSupport('getBatteryInfoSync');
 export const getBatteryInfo = temporarilyNotSupport('getBatteryInfo');

package/dist/api/device/bluetooth-ble.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// 蓝牙-低功耗中心设备
 export const writeBLECharacteristicValue = temporarilyNotSupport('writeBLECharacteristicValue');
 export const setBLEMTU = temporarilyNotSupport('setBLEMTU');
 export const readBLECharacteristicValue = temporarilyNotSupport('readBLECharacteristicValue');

package/dist/api/device/bluetooth-peripheral.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// 蓝牙-低功耗外围设备
 export const onBLEPeripheralConnectionStateChanged = temporarilyNotSupport('onBLEPeripheralConnectionStateChanged');
 export const offBLEPeripheralConnectionStateChanged = temporarilyNotSupport('offBLEPeripheralConnectionStateChanged');
 export const createBLEPeripheralServer = temporarilyNotSupport('createBLEPeripheralServer');

package/dist/api/device/bluetooth.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// 蓝牙-通用
 export const stopBluetoothDevicesDiscovery = temporarilyNotSupport('stopBluetoothDevicesDiscovery');
 export const startBluetoothDevicesDiscovery = temporarilyNotSupport('startBluetoothDevicesDiscovery');
 export const openBluetoothAdapter = temporarilyNotSupport('openBluetoothAdapter');

package/dist/api/device/calendar.js

@@ -1,3 +1,4 @@
 import { temporarilyNotSupport } from '../utils';
+// 日历
 export const addPhoneRepeatCalendar = temporarilyNotSupport('addPhoneRepeatCalendar');
 export const addPhoneCalendar = temporarilyNotSupport('addPhoneCalendar');

package/dist/api/device/clipboard.js

@@ -1,3 +1,9 @@
+/**
+ * 剪贴板部分的api参考了Chameleon项目的实现：
+ *
+ * setClipboardData: https://github.com/chameleon-team/chameleon-api/tree/master/src/interfaces/setClipBoardData
+ * getClipboardData: https://github.com/chameleon-team/chameleon-api/tree/master/src/interfaces/getClipBoardData
+ */
 import { setStorage, setStorageSync, getStorageSync } from '../storage/index';
 import { MethodHandler } from '../utils/handler';
 const CLIPBOARD_STORAGE_NAME = 'taro_clipboard';
@@ -10,10 +16,18 @@ document.addEventListener('copy', () => {
         console.error(e);
     });
 });
+/**
+ * 设置系统剪贴板的内容
+ */
 export const setClipboardData = async ({ data, success, fail, complete }) => {
     const handle = new MethodHandler({ name: 'setClipboardData', success, fail, complete });
     try {
         setStorageSync(CLIPBOARD_STORAGE_NAME, data);
+        /**
+         * 已于 iPhone 6s Plus iOS 13.1.3 上的 Safari 测试通过
+         * iOS < 10 的系统可能无法使用编程方式访问剪贴板，参考：
+         * https://stackoverflow.com/questions/34045777/copy-to-clipboard-using-javascript-in-ios/34046084
+         */
         if (typeof document.execCommand === 'function') {
             const textarea = document.createElement('textarea');
             textarea.readOnly = true;
@@ -36,6 +50,9 @@ export const setClipboardData = async ({ data, success, fail, complete }) => {
         return handle.fail({ errMsg: e.message });
     }
 };
+/**
+ * 获取系统剪贴板的内容
+ */
 export const getClipboardData = async ({ success, fail, complete } = {}) => {
     const handle = new MethodHandler({ name: 'getClipboardData', success, fail, complete });
     try {

package/dist/api/device/compass.js

@@ -1,6 +1,9 @@
 import { CallbackManager, MethodHandler } from '../utils/handler';
 const callbackManager = new CallbackManager();
 let compassListener;
+/**
+ * 停止监听罗盘数据
+ */
 export const stopCompass = ({ success, fail, complete } = {}) => {
     const handle = new MethodHandler({ name: 'stopCompass', success, fail, complete });
     try {
@@ -25,6 +28,9 @@ const getDeviceOrientationListener = interval => {
         timer = setTimeout(() => { lock = false; }, interval);
     };
 };
+/**
+ * 开始监听罗盘数据
+ */
 export const startCompass = ({ success, fail, complete } = {}) => {
     const handle = new MethodHandler({ name: 'startCompass', success, fail, complete });
     try {
@@ -44,9 +50,15 @@ export const startCompass = ({ success, fail, complete } = {}) => {
         return handle.fail({ errMsg: e.message });
     }
 };
+/**
+ * 监听罗盘数据变化事件。频率：5 次/秒，接口调用后会自动开始监听，可使用 wx.stopCompass 停止监听。
+ */
 export const onCompassChange = callback => {
     callbackManager.add(callback);
 };
+/**
+ * 取消监听罗盘数据变化事件，参数为空，则取消所有的事件监听。
+ */
 export const offCompassChange = callback => {
     callbackManager.remove(callback);
 };

package/dist/api/device/contact.js

@@ -1,3 +1,4 @@
 import { temporarilyNotSupport } from '../utils';
+// 联系人
 export const chooseContact = temporarilyNotSupport('chooseContact');
 export const addPhoneContact = temporarilyNotSupport('addPhoneContact');

package/dist/api/device/crypto.js

@@ -1,2 +1,3 @@
 import { temporarilyNotSupport } from '../utils';
+// 加密
 export const getRandomValues = temporarilyNotSupport('getRandomValues');

package/dist/api/device/gyroscope.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// 陀螺仪
 export const stopGyroscope = temporarilyNotSupport('stopGyroscope');
 export const startGyroscope = temporarilyNotSupport('startGyroscope');
 export const onGyroscopeChange = temporarilyNotSupport('onGyroscopeChange');

package/dist/api/device/iBeacon.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// 蓝牙-信标(Beacon)
 export const stopBeaconDiscovery = temporarilyNotSupport('stopBeaconDiscovery');
 export const startBeaconDiscovery = temporarilyNotSupport('startBeaconDiscovery');
 export const onBeaconUpdate = temporarilyNotSupport('onBeaconUpdate');

package/dist/api/device/keyboard.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// 键盘
 export const onKeyboardHeightChange = temporarilyNotSupport('onKeyboardHeightChange');
 export const offKeyboardHeightChange = temporarilyNotSupport('offKeyboardHeightChange');
 export const hideKeyboard = temporarilyNotSupport('hideKeyboard');

package/dist/api/device/memory.js

@@ -1,3 +1,4 @@
 import { temporarilyNotSupport } from '../utils';
+// 内存
 export const onMemoryWarning = temporarilyNotSupport('onMemoryWarning');
 export const offMemoryWarning = temporarilyNotSupport('offMemoryWarning');

package/dist/api/device/motion.js

@@ -15,6 +15,9 @@ const INTERVAL_MAP = {
         frequency: 5
     }
 };
+/**
+ * 停止监听设备方向的变化。
+ */
 export const stopDeviceMotionListening = ({ success, fail, complete } = {}) => {
     const handle = new MethodHandler({ name: 'stopDeviceMotionListening', success, fail, complete });
     try {
@@ -41,6 +44,9 @@ const getDeviceOrientationListener = interval => {
         timer = setTimeout(() => { lock = false; }, interval);
     };
 };
+/**
+ * 开始监听设备方向的变化。
+ */
 export const startDeviceMotionListening = ({ interval = 'normal', success, fail, complete } = {}) => {
     const handle = new MethodHandler({ name: 'startDeviceMotionListening', success, fail, complete });
     try {
@@ -61,9 +67,15 @@ export const startDeviceMotionListening = ({ interval = 'normal', success, fail,
         return handle.fail({ errMsg: e.message });
     }
 };
+/**
+ * 监听设备方向变化事件。
+ */
 export const onDeviceMotionChange = callback => {
     callbackManager.add(callback);
 };
+/**
+ * 取消监听设备方向变化事件，参数为空，则取消所有的事件监听。
+ */
 export const offDeviceMotionChange = callback => {
     callbackManager.remove(callback);
 };

package/dist/api/device/nfc.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// NFC
 export const stopHCE = temporarilyNotSupport('stopHCE');
 export const startHCE = temporarilyNotSupport('startHCE');
 export const sendHCEMessage = temporarilyNotSupport('sendHCEMessage');

package/dist/api/device/phone.js

@@ -1,6 +1,7 @@
 import { shouldBeObject, getParameterError } from '../utils';
 import { MethodHandler } from '../utils/handler';
 export const makePhoneCall = (options) => {
+    // options must be an Object
     const isObject = shouldBeObject(options);
     if (!isObject.flag) {
         const res = { errMsg: `makePhoneCall:fail ${isObject.msg}` };

package/dist/api/device/scan.js

@@ -1,4 +1,5 @@
 import { processOpenApi } from '../utils';
+// 扫码
 export const scanCode = processOpenApi('scanQRCode', { needResult: 1 }, res => ({
     errMsg: res.errMsg === 'scanQRCode:ok' ? 'scanCode:ok' : res.errMsg,
     result: res.resultStr

package/dist/api/device/screen.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// 屏幕
 export const setVisualEffectOnCapture = temporarilyNotSupport('setVisualEffectOnCapture');
 export const setScreenBrightness = temporarilyNotSupport('setScreenBrightness');
 export const setKeepScreenOn = temporarilyNotSupport('setKeepScreenOn');

package/dist/api/device/vibrate.js

@@ -7,6 +7,9 @@ const vibrator = function vibrator(mm) {
         console.warn('当前浏览器不支持vibrate');
     }
 };
+/**
+ * 使手机发生较短时间的振动（15 ms）。仅在 iPhone 7 / 7 Plus 以上及 Android 机型生效
+ */
 export const vibrateShort = ({ success, fail, complete } = {}) => {
     const handle = new MethodHandler({ name: 'vibrateShort', success, fail, complete });
     if (vibrator) {
@@ -17,6 +20,9 @@ export const vibrateShort = ({ success, fail, complete } = {}) => {
         return handle.fail();
     }
 };
+/**
+ * 使手机发生较长时间的振动（400 ms)
+ */
 export const vibrateLong = ({ success, fail, complete } = {}) => {
     const handle = new MethodHandler({ name: 'vibrateLong', success, fail, complete });
     if (vibrator) {

package/dist/api/device/wifi.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// Wi-Fi
 export const stopWifi = temporarilyNotSupport('stopWifi');
 export const startWifi = temporarilyNotSupport('startWifi');
 export const setWifiList = temporarilyNotSupport('setWifiList');

package/dist/api/ext/index.js

@@ -1,3 +1,4 @@
 import { temporarilyNotSupport } from '../utils';
+// 第三方平台
 export const getExtConfigSync = temporarilyNotSupport('getExtConfigSync');
 export const getExtConfig = temporarilyNotSupport('getExtConfig');

package/dist/api/files/index.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// 文件
 export const saveFileToDisk = temporarilyNotSupport('saveFileToDisk');
 export const saveFile = temporarilyNotSupport('saveFile');
 export const removeSavedFile = temporarilyNotSupport('removeSavedFile');

package/dist/api/framework/index.js

@@ -3,4 +3,5 @@ export const getApp = function () {
     return Taro.getCurrentInstance().app;
 };
 export { getCurrentPages } from '@tarojs/router';
+// 自定义组件
 export const getCurrentInstance = Taro.getCurrentInstance;

package/dist/api/location/chooseLocation.js

@@ -44,6 +44,9 @@ function createLocationChooser(handler, key = LOCATION_APIKEY) {
         container
     };
 }
+/**
+ * 打开地图选择位置。
+ */
 export const chooseLocation = ({ success, fail, complete } = {}) => {
     const key = LOCATION_APIKEY;
     const handle = new MethodHandler({ name: 'chooseLocation', success, fail, complete });
@@ -56,7 +59,9 @@ export const chooseLocation = ({ success, fail, complete } = {}) => {
             }, reject);
         }
         const onMessage = event => {
+            // 接收位置信息，用户选择确认位置点后选点组件会触发该事件，回传用户的位置信息
             const loc = event.data;
+            // 防止其他应用也会向该页面 post 信息，需判断 module 是否为'locationPicker'
             if (!loc || loc.module !== 'locationPicker')
                 return;
             chooseLocation.name = loc.poiname;

package/dist/api/location/index.js

@@ -1,4 +1,5 @@
 import { processOpenApi, temporarilyNotSupport } from '../utils/index';
+// 位置
 export const stopLocationUpdate = temporarilyNotSupport('stopLocationUpdate');
 export const startLocationUpdateBackground = temporarilyNotSupport('startLocationUpdateBackground');
 export const startLocationUpdate = temporarilyNotSupport('startLocationUpdate');

package/dist/api/media/audio/index.js

@@ -1,6 +1,7 @@
 import Taro from '@tarojs/api';
 import { temporarilyNotSupport } from '../../utils';
 import { CallbackManager } from '../../utils/handler';
+// 音频
 class InnerAudioContext {
     constructor() {
         this.play = () => { var _a; return (_a = this.Instance) === null || _a === void 0 ? void 0 : _a.play(); };
@@ -15,6 +16,9 @@ class InnerAudioContext {
                 this.Instance.currentTime = position;
             }
         };
+        /**
+         * @TODO destroy得并不干净
+         */
         this.destroy = () => {
             this.stop();
             if (this.Instance) {
@@ -77,5 +81,8 @@ export const pauseVoice = temporarilyNotSupport('pauseVoice');
 export const getAvailableAudioSources = temporarilyNotSupport('getAvailableAudioSources');
 export const createWebAudioContext = temporarilyNotSupport('createWebAudioContext');
 export const createMediaAudioPlayer = temporarilyNotSupport('createMediaAudioPlayer');
+/**
+ * 创建内部 audio 上下文 InnerAudioContext 对象。
+ */
 export const createInnerAudioContext = () => new InnerAudioContext();
 export const createAudioContext = temporarilyNotSupport('createAudioContext');

package/dist/api/media/background-audio.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// 背景音频
 export const stopBackgroundAudio = temporarilyNotSupport('stopBackgroundAudio');
 export const seekBackgroundAudio = temporarilyNotSupport('seekBackgroundAudio');
 export const playBackgroundAudio = temporarilyNotSupport('playBackgroundAudio');

package/dist/api/media/camera.js

@@ -1,2 +1,3 @@
 import { temporarilyNotSupport } from '../utils';
+// 相机
 export const createCameraContext = temporarilyNotSupport('createCameraContext');

package/dist/api/media/editor.js

@@ -1,4 +1,5 @@
 import { temporarilyNotSupport } from '../utils';
+// 富文本
 export class EditorContext {
     constructor() {
         this.blur = temporarilyNotSupport('EditorContext.blur');

package/dist/api/media/image/chooseImage.js

@@ -1,6 +1,10 @@
 import { MethodHandler } from '../../utils/handler';
 import { shouldBeObject, getParameterError } from '../../utils';
+/**
+ * 从本地相册选择图片或使用相机拍照。
+ */
 export const chooseImage = function (options) {
+    // options must be an Object
     const isObject = shouldBeObject(options);
     if (!isObject.flag) {
         const res = { errMsg: `chooseImage:fail ${isObject.msg}` };