Skip to content

@neosjs/request ​

发起 HTTP、HTTPS 网络请求,基于 axios 进行的二次封装。在 axios 之上默认集成了缓存 adapter(GET 请求结果缓存、可设过期时间)、重复请求取消(同一请求进行中自动去重)与失败重试(可配次数与间隔),并提供 before / success / fail / complete 生命周期回调,导出 request、requestAll、requestInstance 三个入口。

安装 ​

sh
pnpm add @neosjs/request
sh
npm i @neosjs/request
sh
yarn add @neosjs/request

TIP

当前版本(2.x)为具名导出,请使用 import { request } from '@neosjs/request'。

快速上手 ​

基础使用 ​

ts
import { request } from '@neosjs/request'

// 方式一:传配置对象
request({
  url: 'http://api.com',
  params: {
    user: 1
  }
}).then((res) => {
  console.log(res)
}).catch((err) => {
  console.log(err)
})

// 方式二:url 在前,配置在后
request('http://api.com', {
  params: {
    user: 1
  }
})

带生命周期回调 ​

ts
import { request } from '@neosjs/request'

request({
  method: 'POST',
  url: 'http://api.com',
  params: {
    user: 1
  },
  // 发起请求之前的回调函数
  before: () => {
    console.log('before')
  },
  // 成功返回的回调函数
  success: (res) => {
    console.log(res)
  },
  // 接口调用失败的回调函数
  fail: (err) => {
    console.log(err)
  },
  // 接口调用结束的回调函数(调用成功、失败都会执行)
  complete: () => {
    console.log('complete')
  }
})

async / await 用法 ​

ts
import { request } from '@neosjs/request'

const res = await request({
  url: 'https://api.com',
  params: {
    id: 1
  }
})

POST / PUT 请求的参数

对于 POST、PUT 请求,params 会作为请求体 data 发送(而非拼接在 URL 上);当请求头 Content-Type 不是 application/json 时,会自动使用 qs 序列化请求体。

requestAll ​

并发发起多个请求,等全部完成后按顺序返回结果数组:

ts
import { request, requestAll } from '@neosjs/request'

const res = await requestAll([
  request({ url: '/api/a' }), // 请求 1
  request({ url: '/api/b' }) // 请求 2
])

console.log(res) // [resA, resB]

requestInstance ​

requestInstance 是底层 axios 实例,用法与 axios 一致:

ts
import { requestInstance } from '@neosjs/request'

const data1 = await requestInstance.get('https://api.com', {
  // ...
})

const data2 = await requestInstance.post('https://api.com', {
  // ...
})

const data3 = await requestInstance({ url: 'https://api.com' })

WARNING

requestInstance 的使用方法同 axios 一致,但 request 扩展的参数(缓存、重试、回调等)可能对 requestInstance 无效。

参数说明 ​

参数说明类型可选值默认值
url请求的 api 地址string--
method请求类型stringPOST、GET、DELETE、HEAD、OPTIONS、PUT、PATCHGET
dataType返回数据类型string-json
timeout超时时间(ms)number-5000
withCredentials是否传递 cookieboolean-false
params请求的参数object--
retry重试次数number-1
retryDelay重试间隔时间(ms)number-2000
cache是否开启缓存boolean-false
cacheMaxAge缓存时间(ms)number-60000
forceUpdate是否强制更新缓存boolean-false
cancelRequest是否取消重复请求boolean-false
headers设置请求的 headerobject-{'Content-Type': 'application/json'}
before发起请求之前的回调函数function-null
after请求完成后的回调函数function-null
success成功返回的回调函数function-null
fail接口调用失败的回调函数function-null
complete接口调用结束的回调函数(调用成功、失败都会执行)function-null

导出清单 ​

导出说明
request主要请求方法,支持 (config) 与 (url, config) 两种传参,返回 PromiseLike<IResponse>
requestAll并发执行多个请求,结果按传入顺序以数组返回
requestInstance底层 axios 实例,用法同 axios

更新于: