README.md

@pansy/omni

🌈 前言

数据结构

请求响应的数据结构:

interface Response {
  /** 请求数据 */
  data: ResponseData;
  /** 请求状态码(Http 状态码) */
  status: number;
  statusText: string;
  /** 请求配置 */
  config: Object;
  /** 请求头 */
  headers: Object;
}

请求响应的数据一般都满足以下约束:

interface ResponseData {
  /** 状态码 */
  code: number;
  /** 数据 */
  data: any;
  /** 信息 */
  message: string;
  /** 
   * 是否成功 
   * 可通过 code 推导获的
   */
  success: boolean;
  [key: string]: any;
}

在平常开发中，大部分的场景只需要消费请求响应中的 data.data，具体请看以下示例:

request().then(res) => {
  if (res.code === 0) {
    const data = res.data.data;

    console.log(data);
  } else {
    const errorMessage = res.data.message;

    errorMessage && message.error(errorMessage)
  }
}

从以上示例可看出，在处理每个请求时，都需要处理以下事项:

• 判断请求是否成功
• 获取嵌套多层的数据
• 处理错误提示

✨ 特性

• 💕 请求共享，避免同时发送相同请求
• 🛡 使用 TypeScript 开发，提供完整的类型定义文件