yunzai-micro-plugin/src/server/utils/result.ts

Yunzai开发管理面板

/**
 * 全局返回结果
 *
 * @class
 * @property {Function} ok 成功
 * @property {Function} error 失败
 * @property noLogin 未登录
 * @property noAuth 无权限
 * @property notFound 未找到
 * @property unrealized 尚未实现
 */
export class Result {
    constructor(public code: number, public result, public message: string, public httpStatus = 200) {
      this.code = code
      this.result = result
      this.message = message
      this.httpStatus = httpStatus
    }
  
    /** 无返回值 */
    static VOID = Symbol();
    /** 尚未实现错误码 */
    static ERR_CODE_501 = Symbol();
  
    /**
     * 成功
     * @static
     * @param result 返回结果
     * @param message 返回消息
     * @returns {Result}
     */
    static ok(result, message = 'ok') {
      return new Result(200, result, message)
    }
  
    /**
     * 错误
     * @static
     * @returns {Result}
     */
    static error(...args) {
      switch (args.length) {

        case 1:
          if (typeof args[0] === 'number') {
            return new Result(args[0], {}, 'error')
          } else {
            return new Result(-1, {}, args[0])
          }

        case 2:
          if (typeof args[0] === 'number') {
            return new Result(args[0], {}, args[1] ?? 'error')
          } else if (typeof args[1] === 'number') {
            return new Result(-1, {}, args[0], args[1])
          } else {
            return new Result(-1, args[1], args[0])
          }

        case 3:
          if (typeof args[0] === 'number') {
            return new Result(args[0], args[1], args[2])
          } else {
            return new Result(-1, args[0], args[1], args[2])
          }

        case 4:
          return new Result(args[0], args[1], args[2], args[3])
      }
    }
  
    /**
     * 尚未登录
     *
     * @returns {Result}
     */
    static noLogin() {
      return new Result(401, null, 'Token失效或尚未登录', 401)
    }
  
    /**
     * 尚未授权
     *
     * @returns {Result}
     */
    static noAuth() {
      return new Result(403, null, '没有权限', 403)
    }
  
    /**
     * 404未找到
     *
     * @returns {Result}
     */
    static notFound() {
      return new Result(404, null, '404 Not Found', 404)
    }
  
    /**
     * 功能尚未实现
     *
     * @returns {Result}
     */
    static unrealized() {
      return new Result(501, null, '该功能在当前版本中尚未实现', 501)
    }
  
    get isOk() {
      return this.code === 0
    }
  
    toJSON() {
      return {
        ok: this.isOk,
        code: this.code,
        result: this.result,
        message: this.message,
      }
    }
}