diff --git a/packages/taro/types/api/base/base.d.ts b/packages/taro/types/api/base/base.d.ts index 424b8e0461ec..c3c3164e0871 100644 --- a/packages/taro/types/api/base/base.d.ts +++ b/packages/taro/types/api/base/base.d.ts @@ -14,10 +14,8 @@ declare namespace Taro { * * `${attribute}` 代表组件属性 * * `${option}` 代表组件属性的可选值 * - * 例子: - * - * **示例:** - * + * @since 1.1.1 + * @example ```js Taro.canIUse('openBluetoothAdapter') Taro.canIUse('getSystemInfoSync.return.screenWidth') diff --git a/packages/taro/types/api/base/base.debug.d.ts b/packages/taro/types/api/base/base.debug.d.ts index f26309728e9a..0d7c172cc1a9 100644 --- a/packages/taro/types/api/base/base.debug.d.ts +++ b/packages/taro/types/api/base/base.debug.d.ts @@ -14,12 +14,9 @@ declare namespace Taro { } } /** - * @since 1.4.0 - * * 设置是否打开调试开关,此开关对正式版也能生效。 - * - * **示例代码:** - * + * @since 1.4.0 + * @example ```javascript // 打开调试 Taro.setEnableDebug({ @@ -37,9 +34,8 @@ declare namespace Taro { namespace getLogManager { type Param = { /** - * @since 2.3.2 - * * 取值为0/1,取值为0表示是否会把 App、Page 的生命周期函数和 wx 命名空间下的函数调用写入日志,取值为1则不会。默认值是 0 + * @since 2.3.2 */ level?: number } @@ -63,12 +59,9 @@ declare namespace Taro { } } /** - * @since 2.1.0 - * * 获取日志管理器对象。 - * - * **示例代码:** - * + * @since 2.1.0 + * @example ```javascript const logger = Taro.getLogManager({level: 1}) logger.log({str: 'hello world'}, 'basic log', 100, [1, 2, 3]) diff --git a/packages/taro/types/api/base/base.system.d.ts b/packages/taro/types/api/base/base.system.d.ts index f9d9f67ce79a..a2a975b80379 100644 --- a/packages/taro/types/api/base/base.system.d.ts +++ b/packages/taro/types/api/base/base.system.d.ts @@ -7,7 +7,6 @@ declare namespace Taro { type Return = { /** * 手机品牌 - * * @since 1.5.0 */ brand: string @@ -21,13 +20,11 @@ declare namespace Taro { pixelRatio: number /** * 屏幕宽度 - * * @since 1.1.0 */ screenWidth: number /** * 屏幕高度 - * * @since 1.1.0 */ screenHeight: number @@ -41,7 +38,6 @@ declare namespace Taro { windowHeight: number /** * 状态栏的高度 - * * @since 1.9.0 */ statusBarHeight: number @@ -63,13 +59,11 @@ declare namespace Taro { platform: string /** * 用户字体大小设置。以“我-设置-通用-字体大小”中的设置为准,单位:px - * * @since 1.5.0 */ fontSizeSetting: number /** * 客户端基础库版本 - * * @since 1.1.0 */ SDKVersion: string @@ -77,9 +71,7 @@ declare namespace Taro { } /** * 获取系统信息同步接口 - * - * **示例代码:** - * + * @example ```javascript try { var res = Taro.getSystemInfoSync() @@ -102,7 +94,6 @@ declare namespace Taro { type Promised = { /** * 手机品牌 - * * @since 1.5.0 */ brand: string @@ -116,13 +107,11 @@ declare namespace Taro { pixelRatio: string /** * 屏幕宽度 - * * @since 1.1.0 */ screenWidth: number /** * 屏幕高度 - * * @since 1.1.0 */ screenHeight: number @@ -136,7 +125,6 @@ declare namespace Taro { windowHeight: number /** * 状态栏的高度 - * * @since 1.9.0 */ statusBarHeight: number @@ -158,13 +146,11 @@ declare namespace Taro { platform: string /** * 用户字体大小设置。以“我-设置-通用-字体大小”中的设置为准,单位:px - * * @since 1.5.0 */ fontSizeSetting: number /** * 客户端基础库版本 - * * @since 1.1.0 */ SDKVersion: string @@ -173,9 +159,7 @@ declare namespace Taro { } /** * 获取系统信息。 - * - * **示例代码:** - * + * @example ```javascript Taro.getSystemInfo({ success: function(res) { diff --git a/packages/taro/types/api/base/base.update.d.ts b/packages/taro/types/api/base/base.update.d.ts index 096ff94d8c01..9e0fa5e08f1a 100644 --- a/packages/taro/types/api/base/base.update.d.ts +++ b/packages/taro/types/api/base/base.update.d.ts @@ -1,13 +1,9 @@ declare namespace Taro { /** - * @since 1.9.90 - * * 获取**全局唯一**的版本更新管理器,用于管理小程序更新。 - * * 关于小程序的更新机制,可以查看 [运行机制](https://developers.weixin.qq.com/miniprogram/dev/framework/runtime/operating-mechanism.html) 文档。 - * - * **示例代码:** - * + * @since 1.9.90 + * @example ```javascript const updateManager = Taro.getUpdateManager() updateManager.onCheckForUpdate(function (res) { diff --git a/packages/taro/types/api/base/base.weapp.d.ts b/packages/taro/types/api/base/base.weapp.d.ts index dc03baffda43..2753b07bc30a 100644 --- a/packages/taro/types/api/base/base.weapp.d.ts +++ b/packages/taro/types/api/base/base.weapp.d.ts @@ -28,14 +28,13 @@ declare namespace Taro { } } /** - * @since 微信小程序 2.1.2 - * * 获取小程序启动时的参数。与 `App.onLaunch` 的回调参数一致。 * * **注意** * 部分版本在无 `referrerInfo` 的时候会返回 undefined, * 建议使用 `options.referrerInfo && options.referrerInfo.appId` 进行判断。 * + * @since 微信小程序 2.1.2 * @see https://developers.weixin.qq.com/miniprogram/dev/api/base/app/life-cycle/wx.getLaunchOptionsSync.html */ function getLaunchOptionsSync(): getLaunchOptionsSync.Return @@ -68,10 +67,8 @@ declare namespace Taro { type onPageNotFoundCallback = (parma: onPageNotFoundCallbackParam) => void } /** - * @since 微信小程序 2.1.2 - * * 监听小程序要打开的页面不存在事件。该事件与 `App.onPageNotFound` 的回调时机一致 - * + * @since 微信小程序 2.1.2 */ function onPageNotFound(callback: onPageNotFound.onPageNotFoundCallback): void @@ -86,23 +83,20 @@ declare namespace Taro { type onErrorCallback = (param: onErrorParam) => void } /** - * @since 微信小程序 2.1.2 - * * 监听小程序错误事件。如脚本错误或 API 调用报错等。该事件与 App.onError 的回调时机与参数一致 + * @since 微信小程序 2.1.2 */ function onError(callback: onError.onErrorCallback): void /** - * @since 微信小程序 2.6.2 - * * 监听音频中断结束事件。在收到 onAudioInterruptionBegin 事件之后,小程序内所有音频会暂停,收到此事件之后才可再次播放成功 + * @since 微信小程序 2.6.2 */ function onAudioInterruptionEnd(callback: () => void): void /** - * @since 微信小程序 2.6.2 - * * 监听音频因为受到系统占用而被中断开始事件。以下场景会触发此事件:闹钟、电话、FaceTime 通话、微信语音聊天、微信视频聊天。此事件触发后,小程序内所有音频会暂停 + * @since 微信小程序 2.6.2 */ function onAudioInterruptionBegin(callback: () => void): void diff --git a/packages/taro/types/api/device/device.accelerometer.d.ts b/packages/taro/types/api/device/device.accelerometer.d.ts index 6b2399b2959a..942827bd567e 100644 --- a/packages/taro/types/api/device/device.accelerometer.d.ts +++ b/packages/taro/types/api/device/device.accelerometer.d.ts @@ -3,12 +3,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 停止监听加速度数据。 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.stopAccelerometer() ``` @@ -20,12 +17,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 开始监听加速度数据。 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.startAccelerometer() ``` @@ -52,9 +46,7 @@ declare namespace Taro { } /** * 监听加速度数据,频率:5次/秒,接口调用后会自动开始监听,可使用 `Taro.stopAccelerometer` 停止监听。 - * - * **示例代码:** - * + * @example ```javascript Taro.onAccelerometerChange(function(res) { console.log(res.x) diff --git a/packages/taro/types/api/device/device.ble.d.ts b/packages/taro/types/api/device/device.ble.d.ts index 33bb0a9de1c3..1bede5f33412 100644 --- a/packages/taro/types/api/device/device.ble.d.ts +++ b/packages/taro/types/api/device/device.ble.d.ts @@ -26,17 +26,13 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 读取低功耗蓝牙设备的特征值的二进制数据值。注意:必须设备的特征值支持`read`才可以成功调用,具体参照 characteristic 的 properties 属性 * * **Bug & Tip:** * * 1. `tip`: 并行调用多次读写接口存在读写失败的可能性。 * 2. `tip`: `read`接口读取到的信息需要在`onBLECharacteristicValueChange`方法注册的回调中获取。 - * - * **示例代码:** - * + * @example ```javascript // 必须在这里的回调才能获取 Taro.onBLECharacteristicValueChange(function(characteristic) { @@ -54,6 +50,7 @@ declare namespace Taro { } }) ``` + * @since 1.1.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/bluetooth-ble/wx.readBLECharacteristicValue.html */ function readBLECharacteristicValue(OBJECT: readBLECharacteristicValue.Param): Promise @@ -72,12 +69,9 @@ declare namespace Taro { } } /** - * @since 1.1.1 - * * 监听低功耗蓝牙连接状态的改变事件,包括开发者主动连接或断开连接,设备丢失,连接异常断开等等 - * - * **示例代码:** - * + * @since 1.1.1 + * @example ```javascript Taro.onBLEConnectionStateChange(function(res) { // 该方法回调中可以用于处理连接意外断开等异常情况 @@ -110,12 +104,9 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 监听低功耗蓝牙设备的特征值变化。必须先启用`notify`接口才能接收到设备推送的notification。 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript // ArrayBuffer转16进度字符串示例 function ab2hex(buffer) { @@ -163,8 +154,6 @@ declare namespace Taro { } } /** - * @since 1.1.1 - * * 启用低功耗蓝牙设备特征值变化时的 notify 功能,订阅特征值。注意:必须设备的特征值支持`notify`或者`indicate`才可以成功调用,具体参照 characteristic 的 properties 属性 * * 另外,必须先启用`notify`才能监听到设备 characteristicValueChange 事件 @@ -173,9 +162,8 @@ declare namespace Taro { * * 1. `tip`: 订阅操作成功后需要设备主动更新特征值的value,才会触发 Taro.onBLECharacteristicValueChange 回调。 * 2. `tip`: 安卓平台上,在调用notify成功后立即调用write接口,在部分机型上会发生 10008 系统错误 - * - * **示例代码:** - * + * @since 1.1.1 + * @example ```javascript Taro.notifyBLECharacteristicValueChange({ state: true, // 启用 notify 功能 @@ -227,16 +215,13 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 获取蓝牙设备所有 service(服务) * * **Bug & Tip:** * * 1. `tip`:iOS平台上后续对特征值的read、write、notify,由于系统需要获取特征值实例,传入的 serviceId 与 characteristicId 必须由 getBLEDeviceServices 与 getBLEDeviceCharacteristics 中获取到后才能使用。建议双平台统一在建立链接后先执行 getBLEDeviceServices 与 getBLEDeviceCharacteristics 后再进行与蓝牙设备的数据交互 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.getBLEDeviceServices({ // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接 @@ -308,17 +293,14 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 获取蓝牙设备某个服务中的所有 characteristic(特征值) * * **Bug & Tip:** * * 1. `tip`:传入的serviceId需要在getBLEDeviceServices获取到 * 2. `tip`:iOS平台上后续对特征值的read、write、notify,由于系统需要获取特征值实例,传入的 serviceId 与 characteristicId 必须由 getBLEDeviceServices 与 getBLEDeviceCharacteristics 中获取到后才能使用。建议双平台统一在建立链接后先执行 getBLEDeviceServices 与 getBLEDeviceCharacteristics 后再进行与蓝牙设备的数据交互 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.getBLEDeviceCharacteristics({ // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接 @@ -349,8 +331,6 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 连接低功耗蓝牙设备。 * * > 若小程序在之前已有搜索过某个蓝牙设备,并成功建立链接,可直接传入之前搜索获取的deviceId直接尝试连接该设备,无需进行搜索操作。 @@ -360,9 +340,8 @@ declare namespace Taro { * 1. `tip`: 安卓手机上如果多次调用create创建连接,有可能导致系统持有同一设备多个连接的实例,导致调用close的时候并不能真正的断开与设备的连接。因此请保证尽量成对的调用create和close接口 * 2. `tip`: 蓝牙链接随时可能断开,建议监听 Taro.onBLEConnectionStateChange 回调事件,当蓝牙设备断开时按需执行重连操作 * 3. `tip`: 若对未连接的设备或已断开连接的设备调用数据读写操作的接口,会返回10006错误,详见错误码,建议进行重连操作 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.createBLEConnection({ // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接 @@ -391,12 +370,9 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 断开与低功耗蓝牙设备的连接 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.closeBLEConnection({ deviceId:deviceId @@ -436,8 +412,6 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 向低功耗蓝牙设备特征值中写入二进制数据。注意:必须设备的特征值支持`write`才可以成功调用,具体参照 characteristic 的 properties 属性 * * _tips: 并行调用多次读写接口存在读写失败的可能性_ @@ -448,9 +422,8 @@ declare namespace Taro { * 2. `tip`: 小程序不会对写入数据包大小做限制,但系统与蓝牙设备会确定蓝牙4.0单次传输的数据大小,超过最大字节数后会发生写入错误,建议每次写入不超过20字节。 * 3. `tip`: 安卓平台上,在调用notify成功后立即调用write接口,在部分机型上会发生 10008 系统错误 * 4. `bug`: 若单次写入数据过长,iOS平台上存在系统不会有任何回调的情况(包括错误回调)。 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript // 向蓝牙设备发送一个0x00的16进制数据 let buffer = new ArrayBuffer(1) diff --git a/packages/taro/types/api/device/device.bluetooth.d.ts b/packages/taro/types/api/device/device.bluetooth.d.ts index 0a20f36d9e1c..28c9dad90f15 100644 --- a/packages/taro/types/api/device/device.bluetooth.d.ts +++ b/packages/taro/types/api/device/device.bluetooth.d.ts @@ -9,12 +9,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 停止搜寻附近的蓝牙外围设备。若已经找到需要的蓝牙设备并不需要继续搜索时,建议调用该接口停止蓝牙搜索。 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.stopBluetoothDevicesDiscovery({ success: function (res) { @@ -49,12 +46,9 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 开始搜寻附近的蓝牙外围设备。注意,该操作比较耗费系统资源,请在搜索并连接到设备后调用 stop 方法停止搜索。 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript // 以微信硬件平台的蓝牙智能灯为例,主服务的 UUID 是 FEE7。传入这个参数,只搜索主服务 UUID 为 FEE7 的设备 Taro.startBluetoothDevicesDiscovery({ @@ -72,8 +66,6 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 初始化小程序蓝牙模块,生效周期为调用`Taro.openBluetoothAdapter`至调用`Taro.closeBluetoothAdapter`或小程序被销毁为止。 在小程序蓝牙适配器模块生效期间,开发者可以正常调用下面的小程序API,并会收到蓝牙模块相关的on回调。 * * **Bug & Tip:** @@ -81,9 +73,8 @@ declare namespace Taro { * 1. `tip`: 基础库版本 1.1.0 开始支持,低版本需做[兼容处理](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) * 2. `tip`: 在没有调用`Taro.openBluetoothAdapter`的情况下调用小程序其它蓝牙模块相关API,API会返回错误,错误码为`10000` * 3. `bug`: 在用户蓝牙开关未开启或者手机不支持蓝牙功能的情况下,调用`Taro.openBluetoothAdapter`会返回错误,错误码为`10001`,表示手机蓝牙功能不可用;此时小程序蓝牙模块已经初始化完成,可通过`Taro.onBluetoothAdapterStateChange`监听手机蓝牙状态的改变,也可以调用蓝牙模块的所有API。 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.openBluetoothAdapter({ success: function (res) { @@ -139,8 +130,6 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 监听寻找到新设备的事件 * * **Bug & Tip:** @@ -148,9 +137,8 @@ declare namespace Taro { * 1. `tip`: Mac系统可能无法获取`advertisData`及`RSSI`,请使用真机调试 * 2. `tip`: 开发者工具和 Android 上获取到的`deviceId`为设备 MAC 地址,iOS 上则为设备 uuid。因此`deviceId`不能硬编码到代码中 * 3. `tip`: 若在onBluetoothDeviceFound回调了某个设备,则此设备会添加到 Taro.getBluetoothDevices 接口获取到的数组中 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript // ArrayBuffer转16进度字符串示例 function ab2hex(buffer) { @@ -186,12 +174,9 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 监听蓝牙适配器状态变化事件 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.onBluetoothAdapterStateChange(function(res) { console.log(`adapterState changed, now is`, res) @@ -234,16 +219,13 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 根据 uuid 获取处于已连接状态的设备 * * **Bug & Tip:** * * 1. `tip`: 开发者工具和 Android 上获取到的`deviceId`为设备 MAC 地址,iOS 上则为设备 uuid。因此`deviceId`不能硬编码到代码中 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.getConnectedBluetoothDevices({ success: function (res) { @@ -303,8 +285,6 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 获取在小程序蓝牙模块生效期间所有已发现的蓝牙设备,包括已经和本机处于连接状态的设备。 * * **Bug & Tip:** @@ -313,9 +293,8 @@ declare namespace Taro { * 2. `tip`: 开发者工具和 Android 上获取到的`deviceId`为设备 MAC 地址,iOS 上则为设备 uuid。因此`deviceId`不能硬编码到代码中 * 3. `tip`: 注意该接口获取到的设备列表为**小程序蓝牙模块生效期间所有搜索到的蓝牙设备**,若在蓝牙模块使用流程结束后未及时调用 Taro.closeBluetoothAdapter 释放资源,会存在调用该接口会返回之前的蓝牙使用流程中搜索到的蓝牙设备,可能设备已经不在用户身边,无法连接。 * 4. `tips`: 蓝牙设备在被搜索到时,系统返回的 name 字段一般为广播包中的LocalName字段中的设备名称,而如果与蓝牙设备建立连接,系统返回的 name 字段会改为从蓝牙设备上获取到的GattName。若需要动态改变设备名称并展示,建议使用localName字段。 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript // ArrayBuffer转16进度字符串示例 function ab2hex(buffer) { @@ -358,12 +337,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 获取本机蓝牙适配器状态 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.getBluetoothAdapterState({ success: function (res) { @@ -379,12 +355,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 关闭蓝牙模块,使其进入未初始化状态。调用该方法将断开所有已建立的链接并释放系统资源。建议在使用小程序蓝牙流程后调用,与`Taro.openBluetoothAdapter`成对调用。 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.closeBluetoothAdapter({ success: function (res) { diff --git a/packages/taro/types/api/device/device.clipboard.d.ts b/packages/taro/types/api/device/device.clipboard.d.ts index 1a6458f66a73..01a50665305e 100644 --- a/packages/taro/types/api/device/device.clipboard.d.ts +++ b/packages/taro/types/api/device/device.clipboard.d.ts @@ -18,14 +18,11 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 设置系统剪贴板的内容 * * **注意** 调用成功后,会弹出 toast 提示"内容已复制",持续 1.5s - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.setClipboardData({ data: 'data', @@ -56,12 +53,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 获取系统剪贴板内容 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.getClipboardData({ success: function(res){ diff --git a/packages/taro/types/api/device/device.compass.d.ts b/packages/taro/types/api/device/device.compass.d.ts index da889c138a46..606b6fcc6649 100644 --- a/packages/taro/types/api/device/device.compass.d.ts +++ b/packages/taro/types/api/device/device.compass.d.ts @@ -3,12 +3,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 停止监听罗盘数据。 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.stopCompass() ``` @@ -20,12 +17,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 开始监听罗盘数据。 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.startCompass() ``` @@ -44,9 +38,7 @@ declare namespace Taro { } /** * 监听罗盘数据,频率:5次/秒,接口调用后会自动开始监听,可使用`Taro.stopCompass`停止监听。 - * - * **示例代码:** - * + * @example ```javascript Taro.onCompassChange(function (res) { console.log(res.direction) diff --git a/packages/taro/types/api/device/device.contact.d.ts b/packages/taro/types/api/device/device.contact.d.ts index 2e732b7c6c28..9cae06051559 100644 --- a/packages/taro/types/api/device/device.contact.d.ts +++ b/packages/taro/types/api/device/device.contact.d.ts @@ -132,8 +132,6 @@ declare namespace Taro { } } /** - * @since 1.2.0 - * * 调用后,用户可以选择将该表单以“新增联系人”或“添加到已有联系人”的方式,写入手机系统通讯录,完成手机通讯录联系人和联系方式的增加。 * * **回调结果:** @@ -143,6 +141,7 @@ declare namespace Taro { * success | ok | 添加成功 * fail | fail cancel | 用户取消操作 * fail | fail ${detail} |调用失败,detail 加上详细信息 + * @since 1.2.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/contact/wx.addPhoneContact.html */ function addPhoneContact(OBJECT: addPhoneContact.Param): Promise diff --git a/packages/taro/types/api/device/device.iBeacon.d.ts b/packages/taro/types/api/device/device.iBeacon.d.ts index 4ea8467f18fc..df2f5e80c617 100644 --- a/packages/taro/types/api/device/device.iBeacon.d.ts +++ b/packages/taro/types/api/device/device.iBeacon.d.ts @@ -9,9 +9,8 @@ declare namespace Taro { type Param = {} } /** - * @since 1.2.0 - * * 停止搜索附近的`iBeacon`设备 + * @since 1.2.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.stopBeaconDiscovery.html */ function stopBeaconDiscovery(OBJECT?: stopBeaconDiscovery.Param): Promise @@ -31,12 +30,9 @@ declare namespace Taro { } } /** - * @since 1.2.0 - * * 开始搜索附近的`iBeacon`设备 - * - * **示例代码:** - * + * @since 1.2.0 + * @example ```javascript Taro.startBeaconDiscovery({ success(res) { @@ -87,9 +83,8 @@ declare namespace Taro { } } /** - * @since 1.2.0 - * * 监听 `iBeacon` 设备的更新事件 + * @since 1.2.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.onBeaconUpdate.html */ function onBeaconUpdate(CALLBACK: onBeaconUpdate.Param): void @@ -108,9 +103,8 @@ declare namespace Taro { } } /** - * @since 1.2.0 - * * 监听 `iBeacon` 服务的状态变化 + * @since 1.2.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.onBeaconServiceChange.html */ function onBeaconServiceChange(CALLBACK: onBeaconServiceChange.Param): void @@ -159,9 +153,8 @@ declare namespace Taro { type Param = {} } /** - * @since 1.2.0 - * * 获取所有已搜索到的`iBeacon`设备 + * @since 1.2.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.getBeacons.html */ function getBeacons(OBJECT?: getBeacons.Param): Promise diff --git a/packages/taro/types/api/device/device.motion.d.ts b/packages/taro/types/api/device/device.motion.d.ts index 19f7d3d2cce6..cfb0dc990120 100644 --- a/packages/taro/types/api/device/device.motion.d.ts +++ b/packages/taro/types/api/device/device.motion.d.ts @@ -19,11 +19,10 @@ declare namespace Taro { /** 接口调用成功的回调函数 */ success?: StopDeviceMotionListeningSuccessCallback } - /** [wx.stopDeviceMotionListening(Object object)](https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.stopDeviceMotionListening.html) - * + /** * 停止监听设备方向的变化。 - * - * 最低基础库: `2.3.0` + * @since 最低基础库: `2.3.0` + * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.stopDeviceMotionListening.html */ function stopDeviceMotionListening( option?: StopDeviceMotionListeningOption, @@ -58,11 +57,10 @@ declare namespace Taro { /** 接口调用成功的回调函数 */ success?: StartDeviceMotionListeningSuccessCallback } - /** [wx.startDeviceMotionListening(Object object)](https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.startDeviceMotionListening.html) - * + /** * 开始监听设备方向的变化。 - * - * 最低基础库: `2.3.0` + * @since 最低基础库: `2.3.0` + * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.startDeviceMotionListening.html */ function startDeviceMotionListening( option: StartDeviceMotionListeningOption, @@ -80,11 +78,10 @@ declare namespace Taro { type OnDeviceMotionChangeCallback = ( result: OnDeviceMotionChangeCallbackResult, ) => void - /** [wx.onDeviceMotionChange(function callback)](https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.onDeviceMotionChange.html) - * + /** * 监听设备方向变化事件。频率根据 [wx.startDeviceMotionListening()](https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.startDeviceMotionListening.html) 的 interval 参数。可以使用 [wx.stopDeviceMotionListening()](https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.stopDeviceMotionListening.html) 停止监听。 - * - * 最低基础库: `2.3.0` + * @since 最低基础库: `2.3.0` + * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.onDeviceMotionChange.html */ function onDeviceMotionChange( /** 设备方向变化事件的回调函数 */ diff --git a/packages/taro/types/api/device/device.network.d.ts b/packages/taro/types/api/device/device.network.d.ts index 2517db3c2bb6..d6e4eb626a14 100644 --- a/packages/taro/types/api/device/device.network.d.ts +++ b/packages/taro/types/api/device/device.network.d.ts @@ -24,12 +24,9 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 监听网络状态变化。 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.onNetworkStatusChange(function(res) { console.log(res.isConnected) diff --git a/packages/taro/types/api/device/device.nfc.d.ts b/packages/taro/types/api/device/device.nfc.d.ts index cbbe0e2df5ef..b632ac48838a 100644 --- a/packages/taro/types/api/device/device.nfc.d.ts +++ b/packages/taro/types/api/device/device.nfc.d.ts @@ -13,12 +13,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.7.0 - * * 关闭 NFC 模块。仅在安卓系统下有效。 - * - * **示例代码:** - * + * @since 1.7.0 + * @example ```javascript Taro.stopHCE({ success: function(res) { @@ -49,12 +46,9 @@ declare namespace Taro { } } /** - * @since 1.7.0 - * * 初始化 NFC 模块。 - * - * **示例代码:** - * + * @since 1.7.0 + * @example ```javascript Taro.startHCE({ aid_list: ['F222222222'] @@ -101,8 +95,6 @@ declare namespace Taro { } } /** - * @since 1.7.0 - * * 发送 NFC 消息。仅在安卓系统下有效。 * * **success返回参数说明:** @@ -121,6 +113,7 @@ declare namespace Taro { } }) ``` + * @since 1.7.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/wx.sendHCEMessage.html */ function sendHCEMessage(OBJECT: sendHCEMessage.Param): Promise @@ -143,12 +136,11 @@ declare namespace Taro { } } /** - * @since 1.7.0 - * * 监听 NFC 设备的消息回调,并在回调中处理。返回参数中 `messageType` 表示消息类型,目前有如下值: * * * 1:消息为HCE Apdu Command类型,小程序需对此指令进行处理,并调用 `sendHCEMessage` 接口返回处理指令; * * 2:消息为设备离场事件 + * @since 1.7.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/wx.onHCEMessage.html */ function onHCEMessage(CALLBACK: onHCEMessage.Param): void @@ -167,8 +159,6 @@ declare namespace Taro { type Param = {} } /** - * @since 1.7.0 - * * 判断当前设备是否支持 HCE 能力。 * * **success返回参数说明:** @@ -180,6 +170,7 @@ declare namespace Taro { } }) ``` + * @since 1.7.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/nfc/wx.getHCEState.html */ function getHCEState(OBJECT?: getHCEState.Param): Promise diff --git a/packages/taro/types/api/device/device.phone.d.ts b/packages/taro/types/api/device/device.phone.d.ts index 0fe17db66e83..bb5735d57f9d 100644 --- a/packages/taro/types/api/device/device.phone.d.ts +++ b/packages/taro/types/api/device/device.phone.d.ts @@ -8,9 +8,7 @@ declare namespace Taro { } } /** - * - * **示例代码:** - * + * @example ```javascript Taro.makePhoneCall({ phoneNumber: '1340000' //仅为示例,并非真实的电话号码 diff --git a/packages/taro/types/api/device/device.scan.d.ts b/packages/taro/types/api/device/device.scan.d.ts index d555e28e44ae..f3ef4cc01da3 100644 --- a/packages/taro/types/api/device/device.scan.d.ts +++ b/packages/taro/types/api/device/device.scan.d.ts @@ -21,13 +21,11 @@ declare namespace Taro { type Param = { /** * 是否只能从相机扫码,不允许从相册选择图片 - * * @since 1.2.0 */ onlyFromCamera?: boolean /** * 扫码类型,参数类型是数组,二维码是'qrCode',一维码是'barCode',DataMatrix是‘datamatrix’,pdf417是‘pdf417’。 - * * @since 1.7.0 */ scanType?: any[] @@ -35,9 +33,7 @@ declare namespace Taro { } /** * 调起客户端扫码界面,扫码成功后返回对应的结果 - * - * **示例代码:** - * + * @example ```javascript // 允许从相机和相册扫码 Taro.scanCode({ diff --git a/packages/taro/types/api/device/device.screen.d.ts b/packages/taro/types/api/device/device.screen.d.ts index 1981165c95dc..d79530ed50ca 100644 --- a/packages/taro/types/api/device/device.screen.d.ts +++ b/packages/taro/types/api/device/device.screen.d.ts @@ -8,9 +8,8 @@ declare namespace Taro { } } /** - * @since 1.2.0 - * * 设置屏幕亮度。 + * @since 1.2.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.setScreenBrightness.html */ function setScreenBrightness(OBJECT: setScreenBrightness.Param): Promise @@ -30,12 +29,9 @@ declare namespace Taro { } } /** - * @since 1.4.0 - * * 设置是否保持常亮状态。仅在当前小程序生效,离开小程序后设置失效。 - * - * **示例代码:** - * + * @since 1.4.0 + * @example ```javascript // 保持屏幕常亮 Taro.setKeepScreenOn({ @@ -47,12 +43,9 @@ declare namespace Taro { function setKeepScreenOn(OBJECT: setKeepScreenOn.Param): Promise /** - * @since 1.4.0 - * * 监听用户主动截屏事件,用户使用系统截屏按键截屏时触发此事件 - * - * **示例代码:** - * + * @since 1.4.0 + * @example ```javascript Taro.onUserCaptureScreen(function(res) { console.log('用户截屏了') @@ -72,14 +65,12 @@ declare namespace Taro { type Param = {} } /** - * @since 1.2.0 - * * 获取屏幕亮度。 * * **Bug & Tip:** * * 1. `tip`: `getScreenBrightness` 接口若安卓系统设置中开启了自动调节亮度功能,则屏幕亮度会根据光线自动调整,该接口仅能获取自动调节亮度之前的值,而非实时的亮度值。 - * + * @since 1.2.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.getScreenBrightness.html */ function getScreenBrightness(OBJECT?: getScreenBrightness.Param): Promise diff --git a/packages/taro/types/api/device/device.vibrate.d.ts b/packages/taro/types/api/device/device.vibrate.d.ts index c7e1d51d5c22..b1b77b959533 100644 --- a/packages/taro/types/api/device/device.vibrate.d.ts +++ b/packages/taro/types/api/device/device.vibrate.d.ts @@ -3,14 +3,13 @@ declare namespace Taro { type Param = {} } /** - * @since 1.2.0 - * * 使手机发生较短时间的振动(15ms) * * **Bug & Tip:** * * 1. `tip`:`vibrateShort` 接口仅在 iPhone7/iPhone7Plus 及 Android 机型生效 * + * @since 1.2.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/vibrate/wx.vibrateShort.html */ function vibrateShort(OBJECT?: vibrateShort.Param): Promise @@ -19,9 +18,8 @@ declare namespace Taro { type Param = {} } /** - * @since 1.2.0 - * * 使手机发生较长时间的振动(400ms) + * @since 1.2.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/vibrate/wx.vibrateLong.html */ function vibrateLong(OBJECT?: vibrateLong.Param): Promise diff --git a/packages/taro/types/api/device/device.wifi.d.ts b/packages/taro/types/api/device/device.wifi.d.ts index b05d227bac8c..4a4b555ac636 100644 --- a/packages/taro/types/api/device/device.wifi.d.ts +++ b/packages/taro/types/api/device/device.wifi.d.ts @@ -3,12 +3,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.6.0 - * * 关闭 Wi-Fi 模块。 - * - * **示例代码:** - * + * @since 1.6.0 + * @example ```javascript Taro.stopWifi({ success: function(res) { @@ -24,12 +21,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.6.0 - * * 初始化 Wi-Fi 模块。 - * - * **示例代码:** - * + * @since 1.6.0 + * @example ```javascript Taro.startWifi({ success: function(res) { @@ -68,8 +62,6 @@ declare namespace Taro { } } /** - * @since 1.6.0 - * * **iOS特有接口** 在 `onGetWifiList` 回调后,利用接口设置 wifiList 中 AP 的相关信息。 * * 注意: @@ -77,9 +69,8 @@ declare namespace Taro { * 1. 该接口只能在 `onGetWifiList` 回调之后才能调用。 * 2. 此时客户端会挂起,等待小程序设置 Wi-Fi 信息,请务必尽快调用该接口,若无数据请传入一个空数组。 * 3. 有可能随着周边 Wi-Fi 列表的刷新,单个流程内收到多次带有存在重复的 Wi-Fi 列表的回调。 - * - * **示例代码:** - * + * @since 1.6.0 + * @example ```javascript Taro.onGetWifiList(function(res) { if (res.wifiList.length) { @@ -133,9 +124,8 @@ declare namespace Taro { } } /** - * @since 1.6.0 - * * 监听连接上 Wi-Fi 的事件。 + * @since 1.6.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.onWifiConnected.html */ function onWifiConnected(CALLBACK: onWifiConnected.Param): void @@ -172,9 +162,8 @@ declare namespace Taro { } } /** - * @since 1.6.0 - * * 监听在获取到 Wi-Fi 列表数据时的事件,在回调中将返回 wifiList。 + * @since 1.6.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.onGetWifiList.html */ function onGetWifiList(CALLBACK: onGetWifiList.Param): void @@ -183,9 +172,8 @@ declare namespace Taro { type Param = {} } /** - * @since 1.6.0 - * * 请求获取 Wi-Fi 列表,在 `onGetWifiList` 注册的回调中返回 wifiList 数据。iOS 将跳转到系统的 Wi-Fi 界面,Android 不会跳转。 **iOS 11.0 及 iOS 11.1 两个版本因系统问题,该方法失效。但在 iOS 11.2 中已修复。** + * @since 1.6.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.getWifiList.html */ function getWifiList(OBJECT?: getWifiList.Param): Promise @@ -221,8 +209,6 @@ declare namespace Taro { type Param = {} } /** - * @since 1.6.0 - * * 获取已连接中的 Wi-Fi 信息 * * **errCode列表:** @@ -244,6 +230,7 @@ declare namespace Taro { * 12009 | system config err | 系统运营商配置拒绝连接 Wi-Fi * 12010 | system internal error |系统其他错误,需要在errmsg打印具体的错误原因 * 12011 | weapp in background | 应用在后台无法配置 Wi-Fi + * @since 1.6.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/wifi/wx.getConnectedWifi.html */ function getConnectedWifi(OBJECT?: getConnectedWifi.Param): Promise @@ -265,12 +252,9 @@ declare namespace Taro { } } /** - * @since 1.6.0 - * * 连接 Wi-Fi。若已知 Wi-Fi 信息,可以直接利用该接口连接。仅 Android 与 iOS 11 以上版本支持。 - * - * **示例代码:** - * + * @since 1.6.0 + * @example ```javascript Taro.connectWifi({ SSID: '', diff --git a/packages/taro/types/api/ext/ext.d.ts b/packages/taro/types/api/ext/ext.d.ts index 2dd4e38f6d3c..608b40222c4d 100644 --- a/packages/taro/types/api/ext/ext.d.ts +++ b/packages/taro/types/api/ext/ext.d.ts @@ -8,16 +8,13 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 获取[第三方平台](https://mp.weixin.qq.com/debug/wxadoc/dev/devtools/ext.html)自定义的数据字段的同步接口。 * * **Bug & Tip:** * * 1. `Taro.getExtConfigSync` 暂时无法通过 `Taro.canIUse` 判断是否兼容,开发者需要自行判断 `Taro.getExtConfigSync` 是否存在来兼容 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript let extConfig = Taro.getExtConfigSync? Taro.getExtConfigSync(): {} console.log(extConfig) @@ -40,16 +37,13 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 获取[第三方平台](https://mp.weixin.qq.com/debug/wxadoc/dev/devtools/ext.html)自定义的数据字段。 * * **Bug & Tip:** * * 1. `Taro.getExtConfig` 暂时无法通过 `Taro.canIUse` 判断是否兼容,开发者需要自行判断 `Taro.getExtConfig` 是否存在来兼容 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript if(Taro.getExtConfig) { Taro.getExtConfig({ diff --git a/packages/taro/types/api/files/files.d.ts b/packages/taro/types/api/files/files.d.ts index 5f9dc764be21..fcd1432acd26 100644 --- a/packages/taro/types/api/files/files.d.ts +++ b/packages/taro/types/api/files/files.d.ts @@ -19,9 +19,7 @@ declare namespace Taro { * **bug & tip:** * * 1. `tip`: 本地文件存储的大小限制为 10M - * - * **示例代码:** - * + * @example ```javascript Taro.chooseImage({ success: function(res) { @@ -49,9 +47,7 @@ declare namespace Taro { } /** * 删除本地存储的文件 - * - * **示例代码:** - * + * @example ```javascript Taro.getSavedFileList({ success: function(res) { @@ -78,7 +74,6 @@ declare namespace Taro { filePath: string /** * 文件类型,指定文件类型打开文件,有效值 doc, xls, ppt, pdf, docx, xlsx, pptx - * * @since 1.4.0 */ fileType?: string @@ -86,9 +81,7 @@ declare namespace Taro { } /** * 新开页面打开文档,支持格式:doc, xls, ppt, pdf, docx, xlsx, pptx - * - * **示例代码:** - * + * @example ```javascript Taro.downloadFile({ url: 'http://example.com/somefile.pdf', @@ -140,9 +133,7 @@ declare namespace Taro { } /** * 获取本地已保存的文件列表 - * - * **示例代码:** - * + * @example ```javascript Taro.getSavedFileList({ success: function(res) { @@ -178,9 +169,7 @@ declare namespace Taro { } /** * 获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件,若需要获取临时文件信息,请使用 [Taro.getFileInfo](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getFileInfo.html) 接口。 - * - * **示例代码:** - * + * @example ```javascript Taro.getSavedFileInfo({ filePath: 'wxfile://somefile', //仅做示例用,非真正的文件路径 @@ -221,12 +210,9 @@ declare namespace Taro { } } /** - * @since 1.4.0 - * * 获取文件信息 - * - * **示例代码:** - * + * @since 1.4.0 + * @example ```javascript Taro.getFileInfo({ success(res) { diff --git a/packages/taro/types/api/location/location.d.ts b/packages/taro/types/api/location/location.d.ts index 32fd5e05e6d9..8b99cc26ae92 100644 --- a/packages/taro/types/api/location/location.d.ts +++ b/packages/taro/types/api/location/location.d.ts @@ -31,9 +31,7 @@ declare namespace Taro { * **Bug & Tip:** * * 1. `bug`: `iOS` `6.3.30` type 参数不生效,只会返回 wgs84 类型的坐标信息 - * - * **示例代码:** - * + * @example ```javascript Taro.getLocation({ type: 'gcj02', //返回可以用于Taro.openLocation的经纬度 @@ -72,19 +70,16 @@ declare namespace Taro { accuracy: number /** * 高度,单位 m - * * @since 1.2.0 */ altitude: number /** * 垂直精度,单位 m(Android 无法获取,返回 0) - * * @since 1.2.0 */ verticalAccuracy: number /** * 水平精度,单位 m - * * @since 1.2.0 */ horizontalAccuracy: number @@ -96,7 +91,6 @@ declare namespace Taro { type?: 'wgs84' | 'gcj02' /** * 传入 true 会返回高度信息,由于获取高度需要较高精确度,会减慢接口返回速度 - * * @since 1.6.0 */ altitude?: boolean @@ -128,9 +122,7 @@ declare namespace Taro { } /** * 获取当前的地理位置、速度。当用户离开小程序后,此接口无法调用;当用户点击“显示在聊天顶部”时,此接口可继续调用。 - * - * **示例代码:** - * + * @example ```javascript Taro.getLocation({ type: 'wgs84', diff --git a/packages/taro/types/api/media/media.audio.d.ts b/packages/taro/types/api/media/media.audio.d.ts index 7b47f0d6f2be..88e50bc0abb7 100644 --- a/packages/taro/types/api/media/media.audio.d.ts +++ b/packages/taro/types/api/media/media.audio.d.ts @@ -2,9 +2,7 @@ declare namespace Taro { /** * **注意:1.6.0 版本开始,本接口不再维护。建议使用能力更强的 [Taro.createInnerAudioContext](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.createInnerAudioContext.html) 接口** * 结束播放语音。 - * - * **示例代码:** - * + * @example ```javascript Taro.startRecord({ success: function(res) { @@ -59,10 +57,8 @@ declare namespace Taro { type ParamPropComplete = () => any } /** - * @since 2.3.0 - * * 设置 InnerAudioContext 的播放选项。设置之后对当前小程序全局生效。 - * + * @since 2.3.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.setInnerAudioOption.html */ function setInnerAudioOption(OBJECT: setInnerAudioOption.Param): Promise @@ -75,7 +71,6 @@ declare namespace Taro { filePath: string /** * 指定录音时长,到达指定的录音时长后会自动停止录音,单位:秒,默认值:60 - * * @since 1.6.0 */ duration?: number @@ -109,9 +104,7 @@ declare namespace Taro { * **注意:1.6.0 版本开始,本接口不再维护。建议使用能力更强的 [Taro.createInnerAudioContext](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.createInnerAudioContext.html) 接口** * * 开始播放语音,同时只允许一个语音文件正在播放,如果前一个语音文件还没播放完,将中断前一个语音播放。 - * - * **示例代码:** - * + * @example ```javascript Taro.startRecord({ success: function(res) { @@ -131,9 +124,7 @@ declare namespace Taro { /** * **注意:1.6.0 版本开始,本接口不再维护。建议使用能力更强的 [Taro.createInnerAudioContext](https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.createInnerAudioContext.html) 接口** * 暂停正在播放的语音。再次调用Taro.playVoice播放同一个文件时,会从暂停处开始播放。如果想从头开始播放,需要先调用 Taro.stopVoice。 - * - * **示例代码:** - * + * @example ```javascript Taro.startRecord({ success: function(res) { @@ -215,16 +206,13 @@ declare namespace Taro { } } /** - * @since 2.1.0 * 获取当前支持的音频输入源。 - * + * @since 2.1.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/audio/wx.getAvailableAudioSources.html */ function getAvailableAudioSources(OBJECT: getAvailableAudioSources.Param): Promise /** - * @since 1.6.0 - * * 创建并返回内部 audio 上下文 `innerAudioContext` 对象。_本接口是 `Taro.createAudioContext` 升级版。_ * * **errCode 说明:** @@ -236,9 +224,8 @@ declare namespace Taro { * 10003 | 文件错误 * 10004 | 格式错误 * -1 | 未知错误 - * - * **示例代码:** - * + * @since 1.6.0 + * @example ```javascript const innerAudioContext = Taro.createInnerAudioContext() innerAudioContext.autoplay = true @@ -277,31 +264,26 @@ declare namespace Taro { obeyMuteSwitch: boolean /** * 当前音频的长度(单位:s),只有在当前有合法的 src 时返回 - * * @readonly */ duration: number /** * 当前音频的播放位置(单位:s),只有在当前有合法的 src 时返回,时间不取整,保留小数点后 6 位 - * * @readonly */ currentTime: number /** * 当前是是否暂停或停止状态,true 表示暂停或停止,false 表示正在播放 - * * @readonly */ paused: boolean /** * 音频缓冲的时间点,仅保证当前播放时间点到此时间点内容已缓冲。 - * * @readonly */ buffered: number /** * 音量。范围 0~1。 - * * @since 1.9.90 */ volume: number @@ -367,61 +349,51 @@ declare namespace Taro { onSeeked(callback?: () => void): void /** * 取消监听 onCanplay 事件 - * * @since 1.9.0 */ offCanplay(callback?: () => void): void /** * 取消监听 onPlay 事件 - * * @since 1.9.0 */ offPlay(callback?: () => void): void /** * 取消监听 onPause 事件 - * * @since 1.9.0 */ offPause(callback?: () => void): void /** * 取消监听 onStop 事件 - * * @since 1.9.0 */ offStop(callback?: () => void): void /** * 取消监听 onEnded 事件 - * * @since 1.9.0 */ offEnded(callback?: () => void): void /** * 取消监听 onTimeUpdate 事件 - * * @since 1.9.0 */ offTimeUpdate(callback?: () => void): void /** * 取消监听 onError 事件 - * * @since 1.9.0 */ offError(callback?: () => void): void /** * 取消监听 onWaiting 事件 - * * @since 1.9.0 */ offWaiting(callback?: () => void): void /** * 取消监听 onSeeking 事件 - * * @since 1.9.0 */ offSeeking(callback?: () => void): void /** * 取消监听 onSeeked 事件 - * * @since 1.9.0 */ offSeeked(callback?: () => void): void diff --git a/packages/taro/types/api/media/media.backgroundAudio.d.ts b/packages/taro/types/api/media/media.backgroundAudio.d.ts index e5a39a438eed..413b5ac38a11 100644 --- a/packages/taro/types/api/media/media.backgroundAudio.d.ts +++ b/packages/taro/types/api/media/media.backgroundAudio.d.ts @@ -1,11 +1,7 @@ declare namespace Taro { /** * 停止播放音乐。 - * - * **示例代码** - * - * **示例:** - * + * @example ```javascript Taro.stopBackgroundAudio() ``` @@ -23,9 +19,7 @@ declare namespace Taro { } /** * 控制音乐播放进度。 - * - * **OBJECT参数说明:** - * + * @example ```javascript Taro.seekBackgroundAudio({ position: 30 @@ -53,9 +47,7 @@ declare namespace Taro { } /** * 使用后台播放器播放音乐,对于微信客户端来说,只能同时有一个后台音乐在播放。当用户离开小程序后,音乐将暂停播放;当用户点击“显示在聊天顶部”时,音乐不会暂停播放;当用户在其他小程序占用了音乐播放器,原有小程序内的音乐将停止播放。 - * - * **OBJECT参数说明:** - * + * @example ```javascript Taro.playBackgroundAudio({ dataUrl: '', @@ -69,11 +61,7 @@ declare namespace Taro { /** * 暂停播放音乐。 - * - * **示例代码** - * - * **示例:** - * + * @example ```javascript Taro.pauseBackgroundAudio() ``` @@ -132,9 +120,7 @@ declare namespace Taro { * **注意:1.2.0 版本开始,本接口不再维护。建议使用能力更强的 [Taro.getBackgroundAudioManager](https://developers.weixin.qq.com/miniprogram/dev/api/media/background-audio/wx.getBackgroundAudioManager.html) 接口** * * 获取后台音乐播放状态。 - * - * **示例代码:** - * + * @example ```javascript Taro.getBackgroundAudioPlayerState({ success: function(res) { @@ -151,8 +137,6 @@ declare namespace Taro { function getBackgroundAudioPlayerState(OBJECT?: getBackgroundAudioPlayerState.Param): Promise /** - * @since 1.2.0 - * * 获取**全局唯一**的背景音频管理器 `backgroundAudioManager`。 * * **errcode 说明:** @@ -164,9 +148,8 @@ declare namespace Taro { * 10003 | 文件错误 * 10004 | 格式错误 * -1 | 未知错误 - * - * **示例代码:** - * + * @since 1.2.0 + * @example ```javascript const backgroundAudioManager = Taro.getBackgroundAudioManager() backgroundAudioManager.title = '此时此刻' @@ -181,19 +164,16 @@ declare namespace Taro { class BackgroundAudioManager { /** * 当前音频的长度(单位:s),只有在当前有合法的 src 时返回 - * * @readonly */ readonly duration: number /** * 当前音频的播放位置(单位:s),只有在当前有合法的 src 时返回 - * * @readonly */ readonly currentTime: number /** * 当前是是否暂停或停止状态,true 表示暂停或停止,false 表示正在播放 - * * @readonly */ readonly paused: boolean @@ -207,7 +187,6 @@ declare namespace Taro { startTime: number /** * 音频缓冲的时间点,仅保证当前播放时间点到此时间点内容已缓冲。 - * * @readonly */ buffered: number @@ -233,7 +212,6 @@ declare namespace Taro { webUrl: string /** * 音频协议。默认值为 'http',设置 'hls' 可以支持播放 HLS 协议的直播音频 - * * @since 1.9.94 */ protocol: string diff --git a/packages/taro/types/api/media/media.camera.d.ts b/packages/taro/types/api/media/media.camera.d.ts index 7927999c4699..0fff098c8eab 100644 --- a/packages/taro/types/api/media/media.camera.d.ts +++ b/packages/taro/types/api/media/media.camera.d.ts @@ -1,11 +1,8 @@ declare namespace Taro { /** - * @since 1.6.0 - * * 创建并返回 camera 上下文 `cameraContext` 对象,`cameraContext` 与页面的 `camera` 组件绑定,一个页面只能有一个camera,通过它可以操作对应的 `` 组件。 在自定义组件下,第一个参数传入组件实例this,以操作组件内 `` 组件 - * - * **示例代码:** - * + * @since 1.6.0 + * @example * [在开发者工具中预览效果](wechatide://minicode/VBZ3Jim26zYu) * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/camera/wx.createCameraContext.html */ diff --git a/packages/taro/types/api/media/media.image.d.ts b/packages/taro/types/api/media/media.image.d.ts index 29becca540d6..9f68a78e89d5 100644 --- a/packages/taro/types/api/media/media.image.d.ts +++ b/packages/taro/types/api/media/media.image.d.ts @@ -14,12 +14,9 @@ declare namespace Taro { } } /** - * @since 1.2.0 - * * 保存图片到系统相册。需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.writePhotosAlbum - * - * **示例代码:** - * + * @since 1.2.0 + * @example ```javascript Taro.saveImageToPhotosAlbum({ success(res) { @@ -44,9 +41,7 @@ declare namespace Taro { } /** * 预览图片。 - * - * **示例代码:** - * + * @example ```javascript Taro.previewImage({ current: '', // 当前显示图片的http链接 @@ -86,13 +81,11 @@ declare namespace Taro { * down-mirrored | 同down,但水平翻转 * left-mirrored | 同left,但垂直翻转 * right-mirrored | 同right,但垂直翻转 - * * @since 1.9.90 */ orientation: 'up' | 'down' | 'left' | 'right' | 'up-mirrored' | 'down-mirrored ' | 'left-mirrored' | 'right-mirrored' /** * 返回图片的格式 - * * @since 1.9.90 */ type: string @@ -106,9 +99,7 @@ declare namespace Taro { } /** * 获取图片信息 - * - * **示例代码:** - * + * @example ```javascript Taro.getImageInfo({ src: 'images/a.jpg', @@ -141,7 +132,6 @@ declare namespace Taro { tempFilePaths: string[] /** * 图片的本地文件列表,每一项是一个 File 对象 - * * @since 1.2.0 */ tempFiles: PromisedPropTempFiles @@ -191,9 +181,7 @@ declare namespace Taro { } /** * 从本地相册选择图片或使用相机拍照。 - * - * **示例代码:** - * + * @example ```javascript Taro.chooseImage({ count: 1, // 默认9 diff --git a/packages/taro/types/api/media/media.live.d.ts b/packages/taro/types/api/media/media.live.d.ts index 8f623fad96a6..18c53e4a3fc8 100644 --- a/packages/taro/types/api/media/media.live.d.ts +++ b/packages/taro/types/api/media/media.live.d.ts @@ -1,11 +1,8 @@ declare namespace Taro { /** - * @since 1.7.0 - * * 创建并返回 `live-pusher` 上下文 `LivePusherContext` 对象,`LivePusherContext` 与页面的 `` 组件绑定,一个页面只能有一个 `live-pusher`,通过它可以操作对应的 `` 组件。 在自定义组件下,第一个参数传入组件实例this,以操作组件内 `` 组件 - * - * **示例代码:** - * + * @since 1.7.0 + * @example * [在开发者工具中预览效果](wechatide://minicode/KvWD9mmA62Yk) * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/live/wx.createLivePusherContext.html */ @@ -203,19 +200,15 @@ declare namespace Taro { switchCamera(OBJECT: LivePusherContext.switchCamera.Param): any /** * 快照 - * * @since 1.9.90 */ snapshot(OBJECT: LivePusherContext.snapshot.Param): any } /** - * @since 1.7.0 - * * 操作对应的 `` 组件。 创建并返回 `live-player` 上下文 `LivePlayerContext` 对象。在自定义组件下,第二个参数传入组件实例this,以操作组件内 `` 组件 - * - * **示例代码:** - * + * @since 1.7.0 + * @example * [在开发者工具中预览效果](wechatide://minicode/UzWEzmm763Y4) * @see https://developers.weixin.qq.com/miniprogram/dev/api/media/live/wx.createLivePlayerContext.html */ @@ -437,13 +430,11 @@ declare namespace Taro { mute(OBJECT: LivePlayerContext.mute.Param): any /** * 暂停 - * * @since 1.9.90 */ pause(OBJECT: LivePlayerContext.pause.Param): any /** * 恢复 - * * @since 1.9.90 */ resume(OBJECT: LivePlayerContext.resume.Param): any diff --git a/packages/taro/types/api/media/media.map.d.ts b/packages/taro/types/api/media/media.map.d.ts index f3aa2b1b7d45..63bdb68e986a 100644 --- a/packages/taro/types/api/media/media.map.d.ts +++ b/packages/taro/types/api/media/media.map.d.ts @@ -218,25 +218,21 @@ declare namespace Taro { moveToLocation(): void /** * 平移marker,带动画 - * * @since 1.2.0 */ translateMarker(OBJECT: MapContext.translateMarker.Param): any /** * 缩放视野展示所有经纬度 - * * @since 1.2.0 */ includePoints(OBJECT: MapContext.includePoints.Param): any /** * 获取当前地图的视野范围 - * * @since 1.4.0 */ getRegion(OBJECT: MapContext.getRegion.Param): any /** * 获取当前地图的缩放级别 - * * @since 1.4.0 */ getScale(OBJECT: MapContext.getScale.Param): any diff --git a/packages/taro/types/api/media/media.recorder.d.ts b/packages/taro/types/api/media/media.recorder.d.ts index dca9fd7b338a..e5ec07db54bf 100644 --- a/packages/taro/types/api/media/media.recorder.d.ts +++ b/packages/taro/types/api/media/media.recorder.d.ts @@ -1,9 +1,7 @@ declare namespace Taro { /** * ​主动调用停止录音。 - * - * **示例代码:** - * + * @example ```javascript Taro.startRecord({ success: function(res) { @@ -42,8 +40,6 @@ declare namespace Taro { function startRecord(OBJECT?: startRecord.Param): Promise /** - * @since 1.6.0 - * * 获取**全局唯一**的录音管理器 `recorderManager`。 * * **其中,采样率和码率有一定要求,具体有效值如下::** @@ -59,9 +55,8 @@ declare namespace Taro { * 32000 | 48000 ~ 192000 * 44100 | 64000 ~ 320000 * 48000 | 64000 ~ 320000 - * - * **示例代码:** - * + * @since 1.6.0 + * @example ```javascript const recorderManager = Taro.getRecorderManager() recorderManager.onStart(() => { diff --git a/packages/taro/types/api/media/media.video.d.ts b/packages/taro/types/api/media/media.video.d.ts index f720a301964f..9ed0c6fdfcf2 100644 --- a/packages/taro/types/api/media/media.video.d.ts +++ b/packages/taro/types/api/media/media.video.d.ts @@ -14,16 +14,13 @@ declare namespace Taro { } } /** - * @since 1.2.0 - * * 保存视频到系统相册。需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.writePhotosAlbum * * **Bug & Tip:** * * 1. `tip`: camera 参数在部分 Android 手机下由于系统 ROM 不支持无法生效 - * - * **示例代码:** - * + * @since 1.2.0 + * @example ```javascript Taro.saveVideoToPhotosAlbum({ filePath: 'wxfile://xxx' @@ -47,7 +44,6 @@ declare namespace Taro { pause(): void /** * 停止 - * * @since 1.7.0 */ stop(): void @@ -61,31 +57,26 @@ declare namespace Taro { sendDanmu(danmu: { text: string; color: string }): void /** * 设置倍速播放,支持的倍率有 0.5/0.8/1.0/1.25/1.5 - * * @since 1.4.0 */ playbackRate(rate: number): void /** * 进入全屏,可传入{direction}参数(1.7.0起支持),详见video组件文档 - * * @since 1.4.0 */ requestFullScreen(param: { direction: 0 | 90 | -90 }): void /** * 退出全屏 - * * @since 1.4.0 */ exitFullScreen(): void /** * 显示状态栏,仅在iOS全屏下有效 - * * @since 2.1.0 */ showStatusBar(): void /** * 隐藏状态栏,仅在iOS全屏下有效 - * * @since 2.1.0 */ hideStatusBar(): void @@ -171,7 +162,6 @@ declare namespace Taro { sourceType?: string[] /** * 是否压缩所选的视频源文件,默认值为true,需要压缩 - * * @since 1.6.0 */ compressed?: boolean diff --git a/packages/taro/types/api/network/network.download.d.ts b/packages/taro/types/api/network/network.download.d.ts index bbb839b86afb..8c2c604ca78f 100644 --- a/packages/taro/types/api/network/network.download.d.ts +++ b/packages/taro/types/api/network/network.download.d.ts @@ -76,7 +76,6 @@ declare namespace Taro { * * **返回值:** * - * @since 1.4.0 * * 返回一个 `downloadTask` 对象,通过 `downloadTask`,可监听下载进度变化事件,以及取消下载任务。 * @@ -118,6 +117,7 @@ declare namespace Taro { }) downloadTask.abort() // 取消下载任务 ``` + * @since 1.4.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/download/wx.downloadFile.html */ function downloadFile(OBJECT: downloadFile.Param): downloadFile.DownloadTask diff --git a/packages/taro/types/api/network/network.request.d.ts b/packages/taro/types/api/network/network.request.d.ts index ac691d290a2f..b43cc101888e 100644 --- a/packages/taro/types/api/network/network.request.d.ts +++ b/packages/taro/types/api/network/network.request.d.ts @@ -19,7 +19,6 @@ declare namespace Taro { statusCode: number /** * 开发者服务器返回的 HTTP Response Header - * * @since 1.2.0 */ header: any @@ -50,62 +49,52 @@ declare namespace Taro { header?: any /** * (需大写)有效值:OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT - * * @default GET */ method?: 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'CONNECT' /** * 如果设为 json,会尝试对返回的数据做一次 JSON.parse - * * @default json */ dataType?: string /** * 设置响应的数据类型。合法值:text、arraybuffer - * * @default text * @since 1.7.0 */ responseType?: string /** * 设置 H5 端是否使用jsonp方式获取数据 - * * @default false */ jsonp?: boolean /** * 设置 H5 端 jsonp 请求 url 是否需要被缓存 - * * @default false */ jsonpCache?: boolean /** * 设置 H5 端是否允许跨域请求。有效值:no-cors, cors, same-origin - * * @default same-origin */ mode?: 'no-cors' | 'cors' | 'same-origin' /** * 设置 H5 端是否携带 Cookie。有效值:include, same-origin, omit - * * @default omit */ credentials?: 'include' | 'same-origin' | 'omit' /** * 设置 H5 端缓存模式。有效值:default, no-cache, reload, force-cache, only-if-cached - * * @default default */ cache?: 'default' | 'no-cache' | 'reload' | 'force-cache' | 'only-if-cached' /** * 设置 H5 端请求响应超时时间 - * * @default 2000 */ timeout?: number /** * 设置 H5 端请求重试次数 - * * @default 2 */ retryTimes?: number @@ -119,7 +108,6 @@ declare namespace Taro { dataCheck?(): boolean /** * 设置 H5 端请求是否使用缓存 - * * @default false */ useStore?: boolean diff --git a/packages/taro/types/api/network/network.upload.d.ts b/packages/taro/types/api/network/network.upload.d.ts index f4452180ea27..c136f211e9aa 100644 --- a/packages/taro/types/api/network/network.upload.d.ts +++ b/packages/taro/types/api/network/network.upload.d.ts @@ -91,8 +91,6 @@ declare namespace Taro { * * **返回值:** * - * @since 1.4.0 - * * 返回一个 `uploadTask` 对象,通过 `uploadTask`,可监听上传进度变化事件,以及取消上传任务。 * * **示例代码:** @@ -139,6 +137,7 @@ declare namespace Taro { }) uploadTask.abort() // 取消上传任务 ``` + * @since 1.4.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/wx.uploadFile.html */ function uploadFile(OBJECT: uploadFile.Param): uploadFile.UploadTask diff --git a/packages/taro/types/api/network/network.webSocket.d.ts b/packages/taro/types/api/network/network.webSocket.d.ts index f167e071ba52..cc56fdf7a22a 100644 --- a/packages/taro/types/api/network/network.webSocket.d.ts +++ b/packages/taro/types/api/network/network.webSocket.d.ts @@ -9,9 +9,7 @@ declare namespace Taro { } /** * 通过 WebSocket 连接发送数据,需要先 [Taro.connectSocket](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/wx.connectSocket.html) 回调之后才能发送。 - * - * **示例代码:** - * + * @example ```javascript var socketOpen = false var socketMsgQueue = [] @@ -44,7 +42,6 @@ declare namespace Taro { type ParamParam = { /** * 连接成功的 HTTP 响应 Header - * * @since 2.0.0 */ header?: any @@ -52,9 +49,7 @@ declare namespace Taro { } /** * 监听WebSocket连接打开事件。 - * - * **示例代码:** - * + * @example ```javascript Taro.connectSocket({ url: 'test.php' @@ -78,9 +73,7 @@ declare namespace Taro { } /** * 监听WebSocket接受到服务器的消息事件。 - * - * **示例代码:** - * + * @example ```javascript Taro.connectSocket({ url: 'test.php' @@ -95,9 +88,7 @@ declare namespace Taro { /** * 监听WebSocket错误。 - * - * **示例代码:** - * + * @example ```javascript Taro.connectSocket({ url: 'test.php' @@ -118,16 +109,13 @@ declare namespace Taro { * * **返回值:** * - * @since 1.7.0 - * * 返回一个 [SocketTask](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.html)。 * * **Bug & Tip:** * * 1. `tip`: 基础库 1.7.0 开始,支持同时存在 2 条 WebSocket 连接 - * - * **示例:** - * + * @since 1.7.0 + * @example ```javascript Taro.connectSocket({ url: 'test.php' @@ -164,7 +152,6 @@ declare namespace Taro { method?: 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'CONNECT' /** * 子协议数组 - * * @since 1.4.0 */ protocols?: string[] @@ -175,9 +162,7 @@ declare namespace Taro { * **使用前请先阅读[说明](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/network.html)**。 * * **基础库 1.7.0 之前,一个微信小程序同时只能有一个 WebSocket 连接,如果当前已存在一个 WebSocket 连接,会自动关闭该连接,并重新创建一个 WebSocket 连接。基础库版本 1.7.0 及以后,支持存在多个 WebSokcet 连接,每次成功调用 Taro.connectSocket 会返回一个新的 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html)。** - * - * **示例代码:** - * + * @example ```javascript Taro.connectSocket({ url: 'wss://example.qq.com', @@ -200,13 +185,11 @@ declare namespace Taro { type Param = { /** * 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。如果这个参数没有被指定,默认的取值是1000 (表示正常连接关闭) - * * @since 1.4.0 */ code?: number /** * 一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本(不是字符) - * * @since 1.4.0 */ reason?: string @@ -307,9 +290,8 @@ declare namespace Taro { } } /** - * @since 1.7.0 - * * WebSocket 任务,可通过 [Taro.connectSocket()](https://developers.weixin.qq.com/miniprogram/dev/api/network/websocket/SocketTask.html) 接口创建返回。 + * @since 1.7.0 */ class SocketTask { @@ -354,42 +336,36 @@ declare namespace Taro { readonly ws: WebSocket /** - * * **SocketTask.send(OBJECT):** * * 通过 WebSocket 连接发送数据。 */ send(OBJECT: SocketTask.send.Param): void /** - * * **SocketTask.close(OBJECT):** * * 关闭 WebSocket 连接。 */ close(OBJECT: SocketTask.close.Param): void /** - * * **SocketTask.onOpen(CALLBACK):** * * 监听 WebSocket 连接打开事件。 */ onOpen(CALLBACK?: any): void /** - * * **SocketTask.onClose(CALLBACK):** * * 监听 WebSocket 连接关闭事件。 */ onClose(CALLBACK?: any): void /** - * * **SocketTask.onError(CALLBACK):** * * 监听 WebSocket 错误。 */ onError(CALLBACK?: SocketTask.onError.Param): void /** - * * **SocketTask.onMessage(CALLBACK):** * * 监听WebSocket接受到服务器的消息事件。 diff --git a/packages/taro/types/api/openAPI/openAPI.account.d.ts b/packages/taro/types/api/openAPI/openAPI.account.d.ts index a6495e58d6dd..73a23985d63c 100644 --- a/packages/taro/types/api/openAPI/openAPI.account.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.account.d.ts @@ -1,11 +1,8 @@ declare namespace Taro { /** - * @since 2.2.2 - * * 获取当前帐号信息 - * - * **示例代码:** - * + * @since 2.2.2 + * @example ```javascript const accountInfo = wx.getAccountInfoSync(); console.log(accountInfo.miniProgram.appId) // 小程序 appId diff --git a/packages/taro/types/api/openAPI/openAPI.address.d.ts b/packages/taro/types/api/openAPI/openAPI.address.d.ts index c4cd1c4ae558..2e90a46de262 100644 --- a/packages/taro/types/api/openAPI/openAPI.address.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.address.d.ts @@ -41,14 +41,11 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 调起用户编辑收货地址原生界面,并在编辑完成后返回用户选择的地址。 * * 需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.address - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.chooseAddress({ success: function (res) { diff --git a/packages/taro/types/api/openAPI/openAPI.authorize.d.ts b/packages/taro/types/api/openAPI/openAPI.authorize.d.ts index 6e1c7908be00..0173980134d1 100644 --- a/packages/taro/types/api/openAPI/openAPI.authorize.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.authorize.d.ts @@ -14,12 +14,9 @@ declare namespace Taro { } } /** - * @since 1.2.0 - * * 提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据,但不会实际调用对应接口。如果用户之前已经同意授权,则不会出现弹窗,直接返回成功。 - * - * **示例代码:** - * + * @since 1.2.0 + * @example ```javascript // 可以通过 Taro.getSetting 先查询一下用户是否授权了 "scope.record" 这个 scope Taro.getSetting({ diff --git a/packages/taro/types/api/openAPI/openAPI.card.d.ts b/packages/taro/types/api/openAPI/openAPI.card.d.ts index a494e2339938..6f4ca79aa992 100644 --- a/packages/taro/types/api/openAPI/openAPI.card.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.card.d.ts @@ -22,17 +22,14 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 查看微信卡包中的卡券。 * * **Tip:** * * 1. `tip`: 目前只有认证小程序才能使用卡券接口,可参考[指引](https://mp.weixin.qq.com/debug/wxadoc/product/renzheng.html)进行认证。 * 2. `tip`: 了解更多信息,请查看[微信卡券接口文档](https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&key=1490190158&version=1&lang=zh_CN&platform=2) - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.openCard({ cardList: [ @@ -117,8 +114,6 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 批量添加卡券。 * * **回调结果:** @@ -128,9 +123,8 @@ declare namespace Taro { * success | addCard:ok | 添加卡券成功 * fail | addCard:fail cancel | 用户取消添加卡券 * fail | addCard:fail (detail message) |添加卡券失败,其中 detail message 为后台返回的详细失败原因 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.addCard({ cardList: [ diff --git a/packages/taro/types/api/openAPI/openAPI.dataAnalysis.d.ts b/packages/taro/types/api/openAPI/openAPI.dataAnalysis.d.ts index e9db07676666..acccb4bfac4b 100644 --- a/packages/taro/types/api/openAPI/openAPI.dataAnalysis.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.dataAnalysis.d.ts @@ -1,9 +1,7 @@ declare namespace Taro { /** * 自定义分析数据上报接口。使用前,需要在小程序管理后台自定义分析中新建事件,配置好事件名与字段。 - * - * **示例代码:** - * + * @example ```javascript Taro.reportAnalytics('purchase', { price: 120, diff --git a/packages/taro/types/api/openAPI/openAPI.invoice.d.ts b/packages/taro/types/api/openAPI/openAPI.invoice.d.ts index 8b0b094fe0ba..2616eac6cfe2 100644 --- a/packages/taro/types/api/openAPI/openAPI.invoice.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.invoice.d.ts @@ -37,14 +37,10 @@ declare namespace Taro { type Param = {} } /** - * @since 1.5.0 - * * 选择用户的发票抬头。 - * * 需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.invoiceTitle - * - * **示例代码:** - * + * @since 1.5.0 + * @example ```javascript Taro.chooseInvoiceTitle({ success(res) { @@ -73,14 +69,10 @@ declare namespace Taro { type Param = {} } /** - * @since 1.5.0 - * * 选择用户的发票抬头。 - * * 需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.invoice - * - * **示例代码:** - * + * @since 1.5.0 + * @example ```javascript Taro.chooseInvoice({ success(res) { diff --git a/packages/taro/types/api/openAPI/openAPI.login.d.ts b/packages/taro/types/api/openAPI/openAPI.login.d.ts index ea7bf9b25778..eddfd6090394 100644 --- a/packages/taro/types/api/openAPI/openAPI.login.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.login.d.ts @@ -13,7 +13,6 @@ declare namespace Taro { type Param = { /** * 超时时间,单位 ms - * * @since 1.9.90 */ timeout?: number @@ -36,9 +35,7 @@ declare namespace Taro { } /** * 调用接口Taro.login() 获取**临时登录凭证(code)** - * - * **示例代码:** - * + * @example ```javascript //app.js App({ @@ -70,9 +67,7 @@ declare namespace Taro { } /** * 校验用户当前session_key是否有效。 - * - * **示例代码:** - * + * @example ```javascript Taro.checkSession({ success: function(){ diff --git a/packages/taro/types/api/openAPI/openAPI.navigate.d.ts b/packages/taro/types/api/openAPI/openAPI.navigate.d.ts index 3ec7037a9a59..1e19a21e1ce4 100644 --- a/packages/taro/types/api/openAPI/openAPI.navigate.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.navigate.d.ts @@ -26,9 +26,7 @@ declare namespace Taro { } } /** - * @since 1.3.0 - * > - * > iOS 微信客户端 6.5.9 版本开始支持,Android 客户端即将在 6.5.10 版本开始支持,请先使用 iOS 客户端进行调试 + * iOS 微信客户端 6.5.9 版本开始支持,Android 客户端即将在 6.5.10 版本开始支持,请先使用 iOS 客户端进行调试 * * 打开同一公众号下关联的另一个小程序。**(注:必须是同一公众号下,而非同个 open 账号下)** * @@ -37,9 +35,8 @@ declare namespace Taro { * 1. `tip`: 在开发者工具上调用此 API 并不会真实的跳转到另外的小程序,但是开发者工具会校验本次调用跳转是否成功[详情](https://developers.weixin.qq.com/miniprogram/dev/devtools/different.html#小程序跳转的调试支持) * 2. `tip`: 开发者工具上支持被跳转的小程序处理接收参数的调试[详情](https://developers.weixin.qq.com/miniprogram/dev/devtools/different.html#小程序跳转的调试支持) * 3. `tip`: 只有同一公众号下的关联的小程序之间才可相互跳转 [详情](https://mp.weixin.qq.com/debug/wxadoc/introduction/index.html#%E5%85%AC%E4%BC%97%E5%8F%B7%E5%85%B3%E8%81%94%E5%B0%8F%E7%A8%8B%E5%BA%8F) - * - * **示例代码:** - * + * @since 1.3.0 + * @example ```javascript Taro.navigateToMiniProgram({ appId: '', @@ -72,14 +69,11 @@ declare namespace Taro { } } /** - * @since 1.3.0 - * > - * > iOS 微信客户端 6.5.9 版本开始支持,Android 客户端即将在 6.5.10 版本开始支持,请先使用 iOS 客户端进行调试 + * iOS 微信客户端 6.5.9 版本开始支持,Android 客户端即将在 6.5.10 版本开始支持,请先使用 iOS 客户端进行调试 * * 返回到上一个小程序,只有在当前小程序是被其他小程序打开时可以调用成功 - * - * **示例代码:** - * + * @since 1.3.0 + * @example ```javascript Taro.navigateBackMiniProgram({ extraData: { diff --git a/packages/taro/types/api/openAPI/openAPI.payment.d.ts b/packages/taro/types/api/openAPI/openAPI.payment.d.ts index f45301f75388..c783175bb021 100644 --- a/packages/taro/types/api/openAPI/openAPI.payment.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.payment.d.ts @@ -61,9 +61,7 @@ declare namespace Taro { * **Bug & Tip:** * * 1. `bug`: 6.5.2 及之前版本中,用户取消支付不会触发 fail 回调,只会触发 complete 回调,回调 errMsg 为 'requestPayment:cancel' - * - * **示例代码:** - * + * @example ```javascript Taro.requestPayment({ 'timeStamp': '', diff --git a/packages/taro/types/api/openAPI/openAPI.report.d.ts b/packages/taro/types/api/openAPI/openAPI.report.d.ts index 09336479f81b..93ff3945c3c6 100644 --- a/packages/taro/types/api/openAPI/openAPI.report.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.report.d.ts @@ -1,11 +1,8 @@ declare namespace Taro { /** - * @since 2.0.1 - * * 自定义业务数据监控上报接口。 - * - * **示例代码:** - * + * @since 2.0.1 + * @example ```javascript Taro.reportMonitor('1', 1) ``` diff --git a/packages/taro/types/api/openAPI/openAPI.settings.d.ts b/packages/taro/types/api/openAPI/openAPI.settings.d.ts index 3232aa12e9f2..b1ef2d67d887 100644 --- a/packages/taro/types/api/openAPI/openAPI.settings.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.settings.d.ts @@ -9,14 +9,11 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 调起客户端小程序设置界面,返回用户设置的操作结果。 * * 注:设置界面只会出现小程序已经向用户请求过的权限。 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.openSetting({ success: (res) => { @@ -41,14 +38,11 @@ declare namespace Taro { type Param = {} } /** - * @since 1.2.0 - * * 获取用户的当前设置。 * * 注:返回值中只会出现小程序已经向用户请求过的权限。 - * - * **示例代码:** - * + * @since 1.2.0 + * @example ```javascript Taro.getSetting({ success: (res) => { diff --git a/packages/taro/types/api/openAPI/openAPI.soter.d.ts b/packages/taro/types/api/openAPI/openAPI.soter.d.ts index 5b2894169cd0..2fc83a75cae4 100644 --- a/packages/taro/types/api/openAPI/openAPI.soter.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.soter.d.ts @@ -54,7 +54,6 @@ declare namespace Taro { } } /** - * @since 1.5.0 * * 开始 SOTER 生物认证 * @@ -81,9 +80,7 @@ declare namespace Taro { "uid":"21" } ``` - * - * **示例代码:** - * + * @example ```javascript Taro.startSoterAuthentication({ requestAuthModes: ['fingerPrint'], @@ -93,6 +90,7 @@ declare namespace Taro { } }) ``` + * @since 1.5.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/soter/wx.startSoterAuthentication.html */ function startSoterAuthentication(OBJECT: startSoterAuthentication.Param): Promise @@ -119,12 +117,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.5.0 - * * 获取本机支持的 SOTER 生物认证方式 - * - * **示例代码:** - * + * @since 1.5.0 + * @example ```javascript Taro.checkIsSupportSoterAuthentication({ success(res) { @@ -165,12 +160,9 @@ declare namespace Taro { } } /** - * @since 1.6.0 - * * 获取设备内是否录入如指纹等生物信息的接口 - * - * **示例代码:** - * + * @since 1.6.0 + * @example ```javascript Taro.checkIsSoterEnrolledInDevice({ checkAuthMode: 'fingerPrint', diff --git a/packages/taro/types/api/openAPI/openAPI.subscribeMessage.d.ts b/packages/taro/types/api/openAPI/openAPI.subscribeMessage.d.ts index 19e6073783fd..4a177d6e8130 100644 --- a/packages/taro/types/api/openAPI/openAPI.subscribeMessage.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.subscribeMessage.d.ts @@ -51,11 +51,10 @@ declare namespace Taro { } /** * 请求订阅消息 - * @param {requestSubscribeMessage.Param} OBJECT 请求订阅消息参数 * * **注意:** 2.8.2 版本开始,用户发生点击行为或者发起支付回调后,才可以调起订阅消息界面。 - * - * **示例代码** + * @param {requestSubscribeMessage.Param} OBJECT 请求订阅消息参数 + * @example ```js wx.requestSubscribeMessage({ tmplIds: [ 'zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE' ], @@ -66,7 +65,6 @@ declare namespace Taro { }) ``` * @since 2.8.2 - * * @see https://developers.weixin.qq.com/miniprogram/dev/api/open-api/subscribe-message/wx.requestSubscribeMessage.html */ function requestSubscribeMessage(OBJECT: requestSubscribeMessage.Param): Promise diff --git a/packages/taro/types/api/openAPI/openAPI.userInfo.d.ts b/packages/taro/types/api/openAPI/openAPI.userInfo.d.ts index 393dc8eca526..c3cbe6cd305b 100644 --- a/packages/taro/types/api/openAPI/openAPI.userInfo.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.userInfo.d.ts @@ -62,19 +62,16 @@ declare namespace Taro { type Param = { /** * 是否带上登录态信息 - * * @since 1.1.0 */ withCredentials?: boolean /** * 指定返回用户信息的语言,zh_CN 简体中文,zh_TW 繁体中文,en 英文。默认为en。 - * * @since 1.3.0 */ lang?: string /** * 超时时间,单位 ms - * * @since 1.9.90 */ timeout?: number diff --git a/packages/taro/types/api/openAPI/openAPI.weRun.d.ts b/packages/taro/types/api/openAPI/openAPI.weRun.d.ts index f8f33ee0991e..c9fd57aee976 100644 --- a/packages/taro/types/api/openAPI/openAPI.weRun.d.ts +++ b/packages/taro/types/api/openAPI/openAPI.weRun.d.ts @@ -31,21 +31,16 @@ declare namespace Taro { type Param = { /** * 超时时间,单位 ms - * * @since 1.9.90 */ timeout?: number } } /** - * @since 1.2.0 - * * 获取用户过去三十天微信运动步数,需要先调用 [Taro.login](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.login.html) 接口。 - * * 需要[用户授权](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/authorize.html) scope.werun - * - * **示例代码:** - * + * @since 1.2.0 + * @example ```javascript Taro.getWeRunData({ success(res) { diff --git a/packages/taro/types/api/router/router.d.ts b/packages/taro/types/api/router/router.d.ts index e6dfcae26709..36aa2efe0b2a 100644 --- a/packages/taro/types/api/router/router.d.ts +++ b/packages/taro/types/api/router/router.d.ts @@ -76,8 +76,6 @@ declare namespace Taro { type ParamPropComplete = () => any } /** - * @since 1.1.0 - * * 关闭所有页面,打开到应用内的某个页面。 * * **示例代码:** @@ -98,6 +96,7 @@ declare namespace Taro { } }) ``` + * @since 1.1.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/route/wx.reLaunch.html */ function reLaunch(OBJECT: reLaunch.Param): Promise @@ -127,9 +126,7 @@ declare namespace Taro { } /** * 关闭当前页面,跳转到应用内的某个页面。 - * - * **示例代码:** - * + * @example ```javascript Taro.redirectTo({ url: 'test?id=1' @@ -191,7 +188,6 @@ declare namespace Taro { type Param = { /** * 返回的页面数,如果 delta 大于现有页面数,则返回到首页。 - * * @default 1 */ delta?: number @@ -218,9 +214,7 @@ declare namespace Taro { * **Tip:** * * 1. `tip`: Taro.navigateTo 和 Taro.redirectTo 不允许跳转到 tabbar 页面,只能用 Taro.switchTab 跳转到 tabbar 页面 - * - * **示例代码:** - * + * @example ```javascript // 注意:调用 navigateTo 跳转时,调用该方法的页面会被加入堆栈,而 redirectTo 方法则不会。见下方示例代码 // 此处是A页面 diff --git a/packages/taro/types/api/share/share.d.ts b/packages/taro/types/api/share/share.d.ts index 6246d1cf76ca..6a25fc6ac575 100644 --- a/packages/taro/types/api/share/share.d.ts +++ b/packages/taro/types/api/share/share.d.ts @@ -44,12 +44,9 @@ declare namespace Taro { } } /** - * @since 1.2.0 - * * 更新转发属性 - * - * **示例代码:** - * + * @since 1.2.0 + * @example ```javascript Taro.updateShareMenu({ withShareTicket: true, @@ -75,12 +72,9 @@ declare namespace Taro { } } /** - * @since 1.1.0 - * * 显示当前页面的转发按钮 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.showShareMenu({ withShareTicket: true @@ -94,12 +88,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.1.0 - * * 隐藏转发按钮 - * - * **示例代码:** - * + * @since 1.1.0 + * @example ```javascript Taro.hideShareMenu() ``` @@ -141,16 +132,14 @@ declare namespace Taro { shareTicket: string /** * 超时时间,单位 ms - * * @since 1.9.90 */ timeout?: number } } /** - * @since 1.1.0 - * * 获取转发详细信息 + * @since 1.1.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.getShareInfo.html */ function getShareInfo(OBJECT: getShareInfo.Param): Promise diff --git a/packages/taro/types/api/storage/storage.d.ts b/packages/taro/types/api/storage/storage.d.ts index 5e501015daed..59634b9657ae 100644 --- a/packages/taro/types/api/storage/storage.d.ts +++ b/packages/taro/types/api/storage/storage.d.ts @@ -1,9 +1,7 @@ declare namespace Taro { /** * 将 data 存储在本地缓存中指定的 key 中,会覆盖掉原来该 key 对应的内容,这是一个同步接口。 - * - * **参数说明:** - * + * @example ```javascript try { Taro.setStorageSync('key', 'value') @@ -28,9 +26,7 @@ declare namespace Taro { } /** * 将数据存储在本地缓存中指定的 key 中,会覆盖掉原来该 key 对应的内容,这是一个异步接口。 - * - * **示例代码:** - * + * @example ```javascript Taro.setStorage({ key:"key", @@ -43,9 +39,7 @@ declare namespace Taro { /** * 从本地缓存中同步移除指定 key 。 - * - * **示例代码:** - * + * @example ```javascript try { Taro.removeStorageSync('key') @@ -67,9 +61,7 @@ declare namespace Taro { } /** * 从本地缓存中异步移除指定 key 。 - * - * **示例代码:** - * + * @example ```javascript Taro.removeStorage({ key: 'key', @@ -84,9 +76,7 @@ declare namespace Taro { /** * 从本地缓存中同步获取指定 key 对应的内容。 - * - * **示例代码:** - * + * @example ```javascript try { var value = Taro.getStorageSync('key') @@ -119,9 +109,7 @@ declare namespace Taro { } /** * 同步获取当前storage的相关信息 - * - * **示例代码:** - * + * @example ```javascript try { var res = Taro.getStorageInfoSync() @@ -155,9 +143,7 @@ declare namespace Taro { } /** * 异步获取当前storage的相关信息 - * - * **示例代码:** - * + * @example ```javascript Taro.getStorageInfo({ success: function(res) { @@ -187,9 +173,7 @@ declare namespace Taro { } /** * 从本地缓存中异步获取指定 key 对应的内容。 - * - * **示例代码:** - * + * @example ```javascript Taro.getStorage({ key: 'key', @@ -208,9 +192,7 @@ declare namespace Taro { * **Bug & Tip:** * * 1. `tip`: 本地数据存储的大小限制为 10MB - * - * **示例代码:** - * + * @example ```javascript try { Taro.clearStorageSync() @@ -224,9 +206,7 @@ declare namespace Taro { /** * 清理本地数据缓存。 - * - * **示例代码:** - * + * @example ```javascript Taro.clearStorage() ``` diff --git a/packages/taro/types/api/ui/ui.animation.d.ts b/packages/taro/types/api/ui/ui.animation.d.ts index bd4389bf6f84..784c299b4f19 100644 --- a/packages/taro/types/api/ui/ui.animation.d.ts +++ b/packages/taro/types/api/ui/ui.animation.d.ts @@ -21,19 +21,16 @@ declare namespace Taro { * ease-out | 动画以低速结束 * step-start |动画第一帧就跳至结束状态直到结束 * step-end |动画一直保持开始状态,最后一帧跳到结束状态 - * * @default linear */ timingFunction?: string /** * 动画延迟时间,单位 ms - * * @default 0 */ delay?: number /** * 设置transform-origin - * * @default 50% 50% 0 */ transformOrigin?: string @@ -45,7 +42,7 @@ declare namespace Taro { * **注意: `export` 方法每次调用后会清掉之前的动画操作** * * **timingFunction 有效值:** - * + * @example ```javascript var animation = Taro.createAnimation({ transformOrigin: "50% 50%", diff --git a/packages/taro/types/api/ui/ui.background.d.ts b/packages/taro/types/api/ui/ui.background.d.ts index 56d77b19f7bb..3e9af739acf3 100644 --- a/packages/taro/types/api/ui/ui.background.d.ts +++ b/packages/taro/types/api/ui/ui.background.d.ts @@ -8,12 +8,9 @@ declare namespace Taro { } } /** - * @since 2.1.0 - * * 动态设置下拉背景字体、loading 图的样式 - * - * **示例代码:** - * + * @since 2.1.0 + * @example ```javascript Taro.setBackgroundTextStyle({ textStyle: 'dark' // 下拉背景字体、loading 图的样式为dark @@ -40,12 +37,9 @@ declare namespace Taro { } } /** - * @since 2.1.0 - * * 动态设置窗口的背景色 - * - * **示例代码:** - * + * @since 2.1.0 + * @example ```javascript Taro.setBackgroundColor({ backgroundColor: '#ffffff', // 窗口的背景色为白色 diff --git a/packages/taro/types/api/ui/ui.keyboard.d.ts b/packages/taro/types/api/ui/ui.keyboard.d.ts index 5a80ad8758e2..6a9953de34e1 100644 --- a/packages/taro/types/api/ui/ui.keyboard.d.ts +++ b/packages/taro/types/api/ui/ui.keyboard.d.ts @@ -1,9 +1,7 @@ declare namespace Taro { /** * 收起键盘。 - * - * **示例代码:** - * + * @example ```javascript Taro.hideKeyboard() ``` @@ -59,9 +57,7 @@ declare namespace Taro { * **注意:** 只有在 `focus `的时候调用此接口才有效。 * * @param option 接口调用的参数 - * - * **示例代码** - * + * @example * ```js wx.getSelectedTextRange({ complete: res => { @@ -69,9 +65,7 @@ declare namespace Taro { } }) ``` - * * @since 2.7.0 - * * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/keyboard/wx.getSelectedTextRange.html */ function getSelectedTextRange(option?: getSelectedTextRange.Param): Promise diff --git a/packages/taro/types/api/ui/ui.menu.d.ts b/packages/taro/types/api/ui/ui.menu.d.ts index 60cfb9fecf4e..1fd0d8bf7175 100644 --- a/packages/taro/types/api/ui/ui.menu.d.ts +++ b/packages/taro/types/api/ui/ui.menu.d.ts @@ -28,9 +28,8 @@ declare namespace Taro { } } /** - * @since 2.1.0 - * * 获取菜单按钮(右上角胶囊按钮)的布局位置信息。坐标信息以屏幕左上角为原点 + * @since 2.1.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/menu/wx.getMenuButtonBoundingClientRect.html */ function getMenuButtonBoundingClientRect(): getMenuButtonBoundingClientRect.Return diff --git a/packages/taro/types/api/ui/ui.navigationBar.d.ts b/packages/taro/types/api/ui/ui.navigationBar.d.ts index 9f5a5616a652..c18d0b6f142b 100644 --- a/packages/taro/types/api/ui/ui.navigationBar.d.ts +++ b/packages/taro/types/api/ui/ui.navigationBar.d.ts @@ -15,9 +15,7 @@ declare namespace Taro { } /** * 动态设置当前页面的标题。 - * - * **示例代码:** - * + * @example ```javascript Taro.setNavigationBarTitle({ title: '当前页面' @@ -82,9 +80,7 @@ declare namespace Taro { } /** * @since 1.4.0 - * - * **示例代码:** - * + * @example ```javascript Taro.setNavigationBarColor({ frontColor: '#ffffff', diff --git a/packages/taro/types/api/ui/ui.pullDownRefresh.d.ts b/packages/taro/types/api/ui/ui.pullDownRefresh.d.ts index 8dc6cd8028e3..88acad097bb2 100644 --- a/packages/taro/types/api/ui/ui.pullDownRefresh.d.ts +++ b/packages/taro/types/api/ui/ui.pullDownRefresh.d.ts @@ -1,9 +1,7 @@ declare namespace Taro { /** * 停止当前页面下拉刷新。 - * - * **示例代码:** - * + * @example ```javascript Page({ onPullDownRefresh: function(){ @@ -25,12 +23,9 @@ declare namespace Taro { type Param = {} } /** - * @since 1.5.0 - * * 开始下拉刷新,调用后触发下拉刷新动画,效果与用户手动下拉刷新一致 - * - * **示例代码:** - * + * @since 1.5.0 + * @example ```javascript Taro.startPullDownRefresh() ``` diff --git a/packages/taro/types/api/ui/ui.scroll.d.ts b/packages/taro/types/api/ui/ui.scroll.d.ts index 2b579fb7f483..1ed8736901c9 100644 --- a/packages/taro/types/api/ui/ui.scroll.d.ts +++ b/packages/taro/types/api/ui/ui.scroll.d.ts @@ -12,12 +12,9 @@ declare namespace Taro { } } /** - * @since 1.4.0 - * * 将页面滚动到目标位置。 - * - * **示例代码:** - * + * @since 1.4.0 + * @example ```javascript Taro.pageScrollTo({ scrollTop: 0, diff --git a/packages/taro/types/api/ui/ui.sticky.d.ts b/packages/taro/types/api/ui/ui.sticky.d.ts index 1f267836d8d9..653a12cea896 100644 --- a/packages/taro/types/api/ui/ui.sticky.d.ts +++ b/packages/taro/types/api/ui/ui.sticky.d.ts @@ -8,12 +8,9 @@ declare namespace Taro { } } /** - * @since 1.4.3 - * * 动态设置置顶栏文字内容,只有当前小程序被置顶时能生效,如果当前小程序没有被置顶,也能调用成功,但是不会立即生效,只有在用户将这个小程序置顶后才换上设置的文字内容。**注意:调用成功后,需间隔 5s 才能再次调用此接口,如果在 5s 内再次调用此接口,会回调 fail,errMsg:"setTopBarText: fail invoke too frequently"** - * - * **示例代码:** - * + * @since 1.4.3 + * @example ```javascript Taro.setTopBarText({ text: 'hello, world!' diff --git a/packages/taro/types/api/ui/ui.tabBar.d.ts b/packages/taro/types/api/ui/ui.tabBar.d.ts index f0002846c609..201620e2d67b 100644 --- a/packages/taro/types/api/ui/ui.tabBar.d.ts +++ b/packages/taro/types/api/ui/ui.tabBar.d.ts @@ -8,9 +8,8 @@ declare namespace Taro { } } /** - * @since 1.9.0 - * * 显示 tabBar 某一项的右上角的红点 + * @since 1.9.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.showTabBarRedDot.html */ function showTabBarRedDot(OBJECT: showTabBarRedDot.Param): Promise @@ -24,9 +23,8 @@ declare namespace Taro { } } /** - * @since 1.9.0 - * * 显示 tabBar + * @since 1.9.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.showTabBar.html */ function showTabBar(OBJECT?: showTabBar.Param): Promise @@ -52,12 +50,9 @@ declare namespace Taro { } } /** - * @since 1.9.0 - * * 动态设置 tabBar 的整体样式 - * - * **示例代码:** - * + * @since 1.9.0 + * @example ```javascript Taro.setTabBarStyle({ color: '#FF0000', @@ -91,12 +86,9 @@ declare namespace Taro { } } /** - * @since 1.9.0 - * * 动态设置 tabBar 某一项的内容 - * - * **示例代码:** - * + * @since 1.9.0 + * @example ```javascript Taro.setTabBarItem({ index: 0, @@ -122,12 +114,9 @@ declare namespace Taro { } } /** - * @since 1.9.0 - * * 为 tabBar 某一项的右上角添加文本 - * - * **示例代码:** - * + * @since 1.9.0 + * @example ```javascript Taro.setTabBarBadge({ index: 0, @@ -147,9 +136,8 @@ declare namespace Taro { } } /** - * @since 1.9.0 - * * 移除 tabBar 某一项右上角的文本 + * @since 1.9.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.removeTabBarBadge.html */ function removeTabBarBadge(OBJECT: removeTabBarBadge.Param): Promise @@ -163,9 +151,8 @@ declare namespace Taro { } } /** - * @since 1.9.0 - * * 隐藏 tabBar 某一项的右上角的红点 + * @since 1.9.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.hideTabBarRedDot.html */ function hideTabBarRedDot(OBJECT: hideTabBarRedDot.Param): Promise @@ -179,9 +166,8 @@ declare namespace Taro { } } /** - * @since 1.9.0 - * * 隐藏 tabBar + * @since 1.9.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.hideTabBar.html */ function hideTabBar(OBJECT?: hideTabBar.Param): Promise diff --git a/packages/taro/types/api/ui/ul.interaction.d.ts b/packages/taro/types/api/ui/ul.interaction.d.ts index ebfa26515e8a..532b5ed67357 100644 --- a/packages/taro/types/api/ui/ul.interaction.d.ts +++ b/packages/taro/types/api/ui/ul.interaction.d.ts @@ -19,7 +19,6 @@ declare namespace Taro { icon?: string /** * 自定义图标的本地路径,image 的优先级高于 icon - * * @since 1.1.0 */ image?: string @@ -59,9 +58,7 @@ declare namespace Taro { } /** * 显示消息提示框 - * - * **示例代码:** - * + * @example ```javascript Taro.showToast({ title: '成功', @@ -81,7 +78,6 @@ declare namespace Taro { confirm: boolean /** * 为 true 时,表示用户点击了取消(用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭) - * * @since 1.1.0 */ cancel: boolean @@ -143,9 +139,7 @@ declare namespace Taro { } /** * ​显示模态弹窗 - * - * **示例代码:** - * + * @example ```javascript Taro.showModal({ title: '提示', @@ -200,9 +194,8 @@ declare namespace Taro { type ParamPropComplete = () => any } /** - * @since 1.1.0 - * * 显示 loading 提示框, 需主动调用 [Taro.hideLoading](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.hideLoading.html) 才能关闭提示框 + * @since 1.1.0 * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html */ function showLoading(OBJECT?: showLoading.Param): Promise @@ -258,9 +251,7 @@ declare namespace Taro { * 2. `tip`: Taro.showActionSheet 点击取消或蒙层时,回调 `fail`, errMsg 为 "showActionSheet:fail cancel"; * 3. `tip`: Taro.showLoading 和 Taro.showToast 同时只能显示一个,但 Taro.hideToast/Taro.hideLoading 也应当配对使用; * 4. `tip`: `iOS` Taro.showModal 点击蒙层不会关闭模态弹窗,所以尽量避免使用“取消”分支中实现业务逻辑。 - * - * **示例代码:** - * + * @example ```javascript Taro.showActionSheet({ itemList: ['A', 'B', 'C'], @@ -283,12 +274,9 @@ declare namespace Taro { function hideToast(): void /** - * @since 1.1.0 - * * 隐藏 loading 提示框 - * - * **示例:** - * + * @since 1.1.0 + * @example ```javascript Taro.showLoading({ title: '加载中', diff --git a/packages/taro/types/api/worker/worker.d.ts b/packages/taro/types/api/worker/worker.d.ts index da29d8de9a35..4a84c4ed37ab 100644 --- a/packages/taro/types/api/worker/worker.d.ts +++ b/packages/taro/types/api/worker/worker.d.ts @@ -1,6 +1,5 @@ declare namespace Taro { /** - * @since 1.9.90 * * 在使用 createWorker 前,请查阅 [多线程](https://developers.weixin.qq.com/miniprogram/dev/framework/workers.html) 文档了解基础知识和配置方法。 * @@ -8,8 +7,8 @@ declare namespace Taro { * * `scriptPath` 为 worker 的入口文件路径,需填写绝对路径。 * - * **示例代码:** - * + * @since 1.9.90 + * @example ```javascript const worker = Taro.createWorker('workers/request/index.js') // 文件名指定 worker 的入口文件路径,绝对路径 worker.onMessage(function (res) { diff --git a/packages/taro/types/api/wxml/wxml.d.ts b/packages/taro/types/api/wxml/wxml.d.ts index fb9ea68eaeba..4e2ec4d4859b 100644 --- a/packages/taro/types/api/wxml/wxml.d.ts +++ b/packages/taro/types/api/wxml/wxml.d.ts @@ -2,7 +2,7 @@ declare namespace Taro { /** * @since 1.4.0 * - * 返回一个SelectorQuery对象实例。可以在这个实例上使用`select`等方法选择节点,并使用`boundingClientRect`等方法选择需要查询的信息。 + * 返回一个 SelectorQuery 对象实例。可以在这个实例上使用`select`等方法选择节点,并使用`boundingClientRect`等方法选择需要查询的信息。 * * **selectorQuery.in(component):** * diff --git a/packages/taro/types/taro.config.d.ts b/packages/taro/types/taro.config.d.ts index 3d8a7acafd23..8796ef40dd5e 100644 --- a/packages/taro/types/taro.config.d.ts +++ b/packages/taro/types/taro.config.d.ts @@ -65,10 +65,10 @@ declare namespace Taro { /** * 禁止页面右滑手势返回 * default: false - * @since 微信客户端 7.0.0 * * **注意** 自微信客户端 7.0.5 开始,页面配置中的 disableSwipeBack 属性将不再生效, * 详情见[右滑手势返回能力调整](https://developers.weixin.qq.com/community/develop/doc/000868190489286620a8b27f156c01)公告 + * @since 微信客户端 7.0.0 */ disableSwipeBack?: boolean } diff --git a/packages/taro/types/taro.lifecycle.d.ts b/packages/taro/types/taro.lifecycle.d.ts index a58c15bfc776..269b0fe85403 100644 --- a/packages/taro/types/taro.lifecycle.d.ts +++ b/packages/taro/types/taro.lifecycle.d.ts @@ -70,7 +70,7 @@ declare namespace Taro { interface TabItemTapObject { /** - * 被点击tabItem的序号,从0开始 + * 被点击tabItem的序号,从 0 开始 * * @since 1.9.0 */