Web HTTP 请求库

一个零依赖，TypeScript 友好，基于 Promise 和 XMLHttpRequest 的 HTTP 请求库。

介绍

• 在浏览器使用 XMLHttpRequest 发起请求
• 支持 Promise API
• 拦截请求和响应
• 转换请求和响应数据
• 取消请求
• 超时处理
• 查询参数序列化支持嵌套项处理
• 自动将请求体序列化为 JSON
• 兼容符合规范的 FormData 和 Blob
• 极小的文件体积: 3.18KB(未进行 GZIP、BR 等压缩时)
• 完全 TypeScript 开发，提供类型支持

安装

使用 npm：

npm add @zhangjiluo.com/request

使用 pnpm：

pnpm add @zhangjiluo.com/request

API

配置缺省请求参数

client.config(config)

client.config({
  base: '',
  contentType: 'json',
  responseType: 'json',
  onResponse(response) {
    return response.body
  },
})

其他方法：

• client.get(url[, search[, options]])
• client.delete(url[, search[, options]])
• client.head(url[, search[, options]])
• client.options(url[, search[, options]])
• client.post(url[, payload[, options]])
• client.put(url[, payload[, options]])
• client.patch(url[, payload[, options]])

用例

发起一个 GET 请求

import client from '@zhangjiluo.com/request'

async function getUser() {
  try {
    // 向给定 ID 的用户发起请求
    const response = await client.get('/user', {
      id: '123',
    })
    console.log(response)
  } catch (error) {
    console.error(error)
  }
}

发起一个 PUT 请求

import client from '@zhangjiluo.com/request'

async function addUser() {
  // 添加一个用户
  const response = await client.put('/user', {
    name: '张三',
  })
}