@agreejs/agree/types/api/ui/pull-down-refresh.d.ts

Agree framework

declare namespace Agree {
  namespace stopPullDownRefresh {
    interface Option {
      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
      complete?: (res: General.CallbackResult) => void
      /** 接口调用失败的回调函数 */
      fail?: (res: General.CallbackResult) => void
      /** 接口调用成功的回调函数 */
      success?: (res: General.CallbackResult) => void
    }
  }

  /** 停止当前页面下拉刷新。
   * @supported weapp, h5, rn
   * @example
   * ```tsx
   * onPullDownRefresh: function (){
   *   Agree.stopPullDownRefresh()
   * }
   * ```
   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/pull-down-refresh/wx.stopPullDownRefresh.html
   */
  function stopPullDownRefresh(option?: stopPullDownRefresh.Option): void

  namespace startPullDownRefresh {
    interface Option {
      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
      complete?: (res: General.CallbackResult) => void
      /** 接口调用失败的回调函数 */
      fail?: (res: General.CallbackResult) => void
      /** 接口调用成功的回调函数 */
      success?: (res: General.CallbackResult) => void
    }
  }

  /** 开始下拉刷新。调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。
   * @supported weapp, h5, rn
   * @rn 无动画效果
   * @example
   * ```tsx
   * Agree.startPullDownRefresh()
   * ```
   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/pull-down-refresh/wx.startPullDownRefresh.html
   */
  function startPullDownRefresh(option?: startPullDownRefresh.Option): Promise<General.CallbackResult>
}