基于Promise微信小程序http请求,轻便,小巧,api友好,功能丰富
- 支持Promise API
- 拦截请求和响应
- 转换请求和响应数据
- 取消请求
- 自动转换为JSON数据
- 超时请求
- 告别callback
- 支持默认请求前缀
- 支持并发请求
yarn add wechat-request
npm install wechat-request --save
pnpm add wechat-request
import wxRequest from 'wechat-request';
首先来一个简单的get请求
// 向具有给定ID的用户发出请求
wxRequest
.get("/user?id=12345")
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});
// 可选地,上面的请求也可以按照
wxRequest
.get("/user", {
params: {
id: "number",
},
})
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});
// 想要使用 async/await? 将`async`关键字添加到外部函数/method
async function getUser() {
try {
const response = await wxRequest.get("/user?ID=12345");
console.log(response);
} catch (error) {
console.error(error);
}
}多种方法使用async/waait,开启代码便捷、畅快之旅
接着再来一个post请求
wxRequest
.post("/user", {
firstname: "firstname",
lastname: "lastname",
})
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});执行多并发请求例子
function getUserAccount() {
return wxRequest.get("/user/12345");
}
function getUserPermissions() {
return wxRequest.get("/user/12345/permissions");
}
wxRequest.all([getUserAccount(), getUserPermissions()]).then((response) => {
// dosoming ...
});当然除了常见的get,post其他的请求也统一封装
wxRequest.request(config)wxRequest.get(url[, config])wxRequest.delete(url[, config])wxRequest.head(url[, config])wxRequest.options(url[, config])wxRequest.post(url[, data[, config]])wxRequest.put(url[, data[, config]])wxRequest.patch(url[, data[, config]])
note: 当使用别名方法
url时,method和data属性不需要在config中指定。
使用场景用户请求需要token,或者地址前缀,一次配置,省时省心。
wxRequest.defaults.baseURL = "https://api.example.com";
wxRequest.defaults.headers["Authorization"] = AUTH_TOKEN;
wxRequest.defaults.headers.post["Content-Type"] = "application/x-www-form-urlencoded";全库已迁移为 TypeScript,响应数据默认泛型为 unknown,调用时显式声明类型:
import wxRequest, { isCancel, CanceledError } from "wechat-request";
import type { RequestConfig, Response } from "wechat-request";
interface User {
id: number;
name: string;
}
// 泛型声明响应数据类型
const res = await wxRequest.get<User>("/user", { params: { id: 12345 } });
console.log(res.data.name);
// POST 携带请求体类型
await wxRequest.post<User, { firstname: string }>("/user", { firstname: "atom" });
// 新建独立实例(与全局实例隔离配置)
const api = wxRequest.create({ baseURL: "https://api.example.com", timeout: 5000 });
// 类型化拦截器
api.interceptors.request.use((config: RequestConfig) => {
config.headers = { ...(config.headers ?? {}), Authorization: AUTH_TOKEN };
return config;
});
// 状态码校验 + 响应转换
const strict = wxRequest.create({
validateStatus: (status) => status >= 200 && status < 300,
transformResponse: (data) => data,
});
// AbortController 取消请求
const controller = new AbortController();
try {
await wxRequest.get("/slow", { signal: controller.signal });
} catch (err) {
if (isCancel(err) || err instanceof CanceledError) {
console.log("请求已取消");
}
}
// 表单别名(自动设置 multipart/form-data 请求头)
await wxRequest.postForm("/upload", { name: "a" });说明:
wxRequest.all/wxRequest.spread作为兼容 API 保留,新代码建议直接使用Promise.all。
pnpm install # 安装依赖
pnpm test # 运行 Vitest 用例
pnpm typecheck # tsc --noEmit 类型检查
pnpm build # 构建 dist/index.js(UMD/CJS)+ dist/index.mjs(ESM)+ 根目录 index.d.ts运行时仍使用微信小程序
wx.request,未切换平台;构建产物保持main: dist/index.js/types: index.d.ts不变。CommonJSconst wxRequest = require('wechat-request')直接得到请求实例(另挂载isCancel/isAxiosError/CanceledError),与旧版一致;ESM 既可用默认导入,也可用命名导入。
MIT