codestar-base

封装的底层常用类型和方法

Result 用于描述各类执行结果

Result<T> {
  code: string = '' // 错误码， "00"表示成功，其他均表示错误
  msg: string = '' // 错误描述
  success: boolean = false // 是否成功
  data?: T // 携带的数据
  errors?: { [field: string]: string } // 错误描述，通常用于表单验证失败，返回验证失败字段的详细错误
  args?: Record<string, string | number> // 错误描述的 占位符参数，用于i18n翻译
}

ResultBuilder 用于快速构建各场景下的Result对象

import ResultBuilder from "./ResultBuilder";
// 等价于 {success:true, code:"00", data}
ResultBuilder.ok(data);
// 等价于 {success:false, code:"01", msg:"error message"}
ResultBuilder.error("error message")
// 解析结果，比如解析服务器返回的字符串转成Result对象
ResultBuilder.parse('{code:"00", data:"hello"}')
// 更详细的Result封装
ResultBuilder.success({data:T, msg:"description"})
ResultBuilder.fail({
  code:'01',
  msg:'invalid request',
  errors:{username:"Length exceeds the limit"},
  args:{}
})