interface.uts 1.7 KB
Newer Older
DCloud-yyl's avatar
DCloud-yyl 已提交
1 2 3 4 5 6 7
/**
 * uni.exit成功回调参数
 */
export type ExitSuccess = {
  errMsg: string
}

DCloud-yyl's avatar
DCloud-yyl 已提交
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/**
 * 错误码
 * - 12001: 系统不支持
 * - 12002: 未知错误
 */
export type ExitErrorCode = 12001 | 12002

/**
 * uni.exit失败回调参数
 */
export interface IExitError extends IUniError {
	errCode: ExitErrorCode
}
export type ExitFail = IExitError

DCloud-yyl's avatar
DCloud-yyl 已提交
23 24 25 26 27 28 29
/**
 * uni.exit成功回调函数定义
 */
export type ExitSuccessCallback = (res: ExitSuccess) => void
/**
 * uni.exit失败回调函数定义
 */
DCloud-yyl's avatar
DCloud-yyl 已提交
30
export type ExitFailCallback = (res: ExitFail) => void
DCloud-yyl's avatar
DCloud-yyl 已提交
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
/**
 * uni.exit完成回调函数定义
 */
export type ExitCompleteCallback = (res: any) => void

/**
 * uni.exit参数定义
 */
export type ExitOptions = {
  /**
   * 接口调用成功的回调函数
   */
  success?: ExitSuccessCallback | null,
  /**
   * 接口调用失败的回调函数
   */
  fail?: ExitFailCallback | null,
  /**
   * 接口调用结束的回调函数(调用成功、失败都会执行)
   */
  complete?: ExitCompleteCallback | null
}


export interface Uni {

  /**
   * 退出当前应用
   * @uniPlatform {
   *    "app": {
   *        "android": {
DCloud-yyl's avatar
DCloud-yyl 已提交
62
   *            "osVer": "5.0",
DCloud-yyl's avatar
DCloud-yyl 已提交
63
   *            "uniVer": "3.8.15",
DCloud-yyl's avatar
DCloud-yyl 已提交
64
   *            "uniUtsPlugin": "3.9.0",
DCloud-yyl's avatar
DCloud-yyl 已提交
65
   *            "unixVer": "3.9.0",
DCloud-yyl's avatar
DCloud-yyl 已提交
66
   *            "unixUtsPlugin": "3.9.0"
DCloud-yyl's avatar
DCloud-yyl 已提交
67 68 69 70
   *        },
   *        "ios": {
   *            "osVer": "x",
   *            "uniVer": "x",
DCloud-yyl's avatar
DCloud-yyl 已提交
71
   *            "uniUtsPlugin": "x",
DCloud-yyl's avatar
DCloud-yyl 已提交
72
   *            "unixVer": "x",
DCloud-yyl's avatar
DCloud-yyl 已提交
73
   *            "unixUtsPlugin": "x"
DCloud-yyl's avatar
DCloud-yyl 已提交
74
   *   	  }
DCloud-yyl's avatar
DCloud-yyl 已提交
75 76 77 78 79
   *    },
   *  "web": {
   *    "uniVer": "x",
   *    "unixVer": "x"
   *  }
DCloud-yyl's avatar
DCloud-yyl 已提交
80 81 82 83 84 85 86
   * }
   * @uniVueVersion 2,3  //支持的vue版本
   */
  exit(options?: ExitOptions | null):void;
}

export type Exit = (options?: ExitOptions | null) => void;