interface.uts 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. /**
  2. * interface.uts
  3. * uts插件接口定义文件,按规范定义接口文件可以在HBuilderX中更好的做到语法提示
  4. */
  5. /**
  6. * myApi 异步函数的参数,在type里定义函数需要的参数以及api成功、失败的相关回调函数。
  7. */
  8. export type MyApiOptions = {
  9. paramA : boolean
  10. success ?: (res : MyApiResult) => void
  11. fail ?: (res : MyApiFail) => void
  12. complete ?: (res : any) => void
  13. }
  14. /**
  15. * 函数返回结果
  16. * 可以是void, 基本数据类型,自定义type, 或者其他类型。
  17. * [可选实现]
  18. */
  19. export type MyApiResult = {
  20. fieldA : number,
  21. fieldB : boolean,
  22. fieldC : string
  23. }
  24. /**
  25. * 错误码
  26. * 根据uni错误码规范要求,建议错误码以90开头,以下是错误码示例:
  27. * - 9010001 错误信息1
  28. * - 9010002 错误信息2
  29. */
  30. export type MyApiErrorCode = 9010001 | 9010002;
  31. /**
  32. * myApi 的错误回调参数
  33. */
  34. export interface MyApiFail extends IUniError {
  35. errCode : MyApiErrorCode
  36. };
  37. /* 异步函数定义 */
  38. export type MyApi = (options : MyApiOptions) => void
  39. /* 同步函数定义 */
  40. export type MyApiSync = (paramA : boolean) => MyApiResult