@tarojs/taro/types/api/ui/custom-component.d.ts

Taro framework

import Taro from '../../index'

declare module '../../index' {
  interface TaroStatic {
    /** 延迟一部分操作到下一个时间片再执行。（类似于 setTimeout）
     *
     * **说明**
     * 因为自定义组件中的 setData 和 triggerEvent 等接口本身是同步的操作，当这几个接口被连续调用时，都是在一个同步流程中执行完的，因此若逻辑不当可能会导致出错。
     * 一个极端的案例：当父组件的 setData 引发了子组件的 triggerEvent，进而使得父组件又进行了一次 setData，期间有通过 wx:if 语句对子组件进行卸载，就有可能引发奇怪的错误，所以对于不需要在一个同步流程内完成的逻辑，可以使用此接口延迟到下一个时间片再执行。
     * @supported weapp, h5, harmony_hybrid
     * @example
     * ```tsx
     * this.setData({ number: 1 }) // 直接在当前同步流程中执行
     * Taro.nextTick(() => {
     *   this.setData({ number: 3 }) // 在当前同步流程结束后，下一个时间片执行
     * })
     * this.setData({ number: 2 }) // 直接在当前同步流程中执行
     * ```
     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/custom-component/wx.nextTick.html
     */
    nextTick(callback: (...args: any[]) => any): void
  }
}