@p2k0/request v0.2.3

@p2k0/request

一个基于 axios 封装的类支持 TypeScript，支持 get、post、put、patch、delete、head、options、downloadSteam 方法并添加了几个回调函数 。

• before：在发送请求之前修改请求配置（拦截器）。
• after：在成功响应后对响应数据进行处理（拦截器）。
• error：在出现错误时进行处理（回调）。
• finally：在请求结束时进行一些额外的处理（回调）。

以上拦截器跟回调都是可选支持无限链式的。

downloadSteam 不会触发拦截器，它没有用回初始化后的实例。您需要重新传入配置项。

安装

npm

npm install @p2k0/request -S

yarn

yarn add @p2k0/request -S

pnpm

pnpm add @p2k0/request -S

示例

New Request

import Request from '@p2k0/request';

const request = new Request({
    timeout: 5000 
})
  .before((config) => {
    config.headers["Authorization"] = "Bearer xxxxxx";
    return config;
  })
  .before((config) => {
    config.custom = "custom";
    return config;
  })
  .after((res) => {
    res.custom = "我自定义咯";
    return res;
  })
  .after((res) => {
    res.a = "ccc";
    return res;
  })
  .error((err) => {
    console.log(err);
  })
  .finally((err, res) => {
    console.log("final", err, res);
  });

GET

request.get<{ data: string }>("/endpoint").then(res => {
  console.log(res.data); // 输出响应数据
});

POST

request.post<{ message: string }>("/endpoint", { data: "example" }).then(res => {
  console.log(res.message); // 输出响应消息
});

PUT

request.put<{ success: boolean }>("/endpoint/123", { data: "example" }).then(res => {
  console.log(res.success); // 输出 PUT 方法是否成功
});

PATCH

request.patch<{ updated: boolean }>("/endpoint/456", { data: "example" }).then(res => {
  console.log(res.updated); // 输出 PATCH 方法是否成功
});

DELETE

request.delete<{ deleted: boolean }>("/endpoint/789").then(res => {
  console.log(res.deleted); // 输出 DELETE 方法是否成功
});

HEAD

request.head("/endpoint").then(res => {
  console.log(res.headers); // 输出响应头信息
});

OPTIONS

request.options<{ allowedMethods: string[] }>("/endpoint").then(res => {
  console.log(res.allowedMethods); // 输出该端点允许的 HTTP 方法列表
});

DownloadSteam

// 浏览器环境
request.downloadSteam({
  url: 'https://jsonplaceholder.typicode.com/posts',
  filename: 'posts.json'
})
  .then(() => console.log('下载成功'))

// Node.js 环境
request.downloadSteam({
  url: 'https://jsonplaceholder.typicode.com/posts',
  filename: 'posts.json',
  filePath: 'xxx/a/b/'
})
  .then(() => console.log('下载成功'))

取消重复请求

request.post({
  url: "/api/login",
  data: {
    username: "test",
    password: "test123"
  },
  cancelable: true // 开启取消重复请求的功能
});