@stroll/http v0.1.3

安装

npm i -S @stroll/http

引入

import http from "@stroll/http";

调用

/** config 配置
 * @param {string} baseURL 基础URL
 * @param {string} method 请求方法
 * @param {string} url 请求地址
 * @param {string} headers 请求头
 * @param {string} body 请求体
 * @param {string} params 请求参数
 * @param {string} signal 关闭标识
 * @param {string} timeout 超时时间
 * @param {string} requestInterceptors 请求拦截器
 * @param {string} responseInterceptors 响应拦截器
 * @param {string} onError 错误处理
 * @param {string} keepalive 是否允许关闭页面后继续发送请求
 * @param {string} credentials 确定浏览器是否应该发送cookie， omit 不发送， same-origin 发送同域的cookie， cors 发送跨域的cookie， navigate 发送所有cookie
 * @param {string} mode 设置请求的跨域行为
 * @param {string} referrer 指定用于请求的 Referer 标头的值字符串
 * @param {string} referrerPolicy 一个设置 Referer 标头策略的字符串。此选项的语法和语义与 Referrer-Policy 标头完全相同。
 * @param {string} browsingTopics 布尔值，指定应将当前用户的选定主题发送到与请求关联的 Sec-Browsing-Topics 标题中。
 * @param {string} cache 请求要使用的缓存模式
 * @param {string} priority 指定了 fetch 请求相对于同一类型的其他请求的优先级
 * @param {string} responseType null
 * @param {string} window null
 * @param {string} dispatcher
 * @param {string} duplex half
 */
export const HTTP = http.create({
  baseURL: 'http://127.0.0.1:6060',
  timeout: 3000,
  // 请求拦截器
  requestInterceptors: (config) => {
    // ...
    return config
  },
  // 响应拦截器
  responseInterceptors: (response) => {
    // ...
    return response
  },
  // 错误处理
  onError: (error) => {
    // ...
  }
})
//or 
export const HTTP = new http({
  baseURL: 'http://127.0.0.1:6060',
  timeout: 3000,
})

HTTP.interceptRequest((config)) => {
  console.log('请求拦截器')
  return config;
})
HTTP.interceptResponse((response)) => {
  console.log('响应拦截器')
  return response;
}
HTTP.onError((err)) => {
  console.log('错误处理')
}

取消请求

HTTP.cancel('请求时定义的 signal')

get 请求

HTTP.get({
  url:'/test',
  params: {
    a: 1
  },
}).then((res) => {
  console.log('res', res.data)
})

//  流式返回文本防deepseek
http.getStreamText({
  url:'/stream'
}, (res: any)=> {
  console.log('res', res)
}).then((res: any)=> {
  console.log('res----------', res)
});

//  下载文件
HTTP.getDL({
  url:'/test',
  params: {
    a: 1
  },
}, (res) => {
  console.log('进度', res)
}).then((res) => {
  console.log('res', res.data)
})

post 请求

HTTP.post({
  url:'/test',
  params: {b:1},
  body: {a:2}
}).then((res) => {
  console.log('res', res.data)
})

// 表单
HTTP.postForm({
  url:'/test',
  body: {a:2}
}).then((res) => {
  console.log('res', res.data)
})

// 下载文件
HTTP.postDL({
  url:'/test',
  params: {b:1},
  body: {a:2}
}).then((res) => {
  console.log('res', res.data)
})

// 上传文件
HTTP.postFileForm({
  url:'/test',
  params: {b:1},
  body: {a:2， file：File||File[]},
}, (res) => {
  console.log('进度', res)
}).then((res) => {
  console.log('res', res.data)
})

/** 文件分块上传
   * 实际分片发送数据
   * - file: 要上传的文件分片
   * - fileName：文件名
   * - fileType：文件类型
   * - chunkIndex：切片序号，从0开始
   * - totalChunks：切片总数
   * - md5：当前文件分片的MD5值，用于校验
   * - md5All：整个文件的MD5值，用于校验
   * 
   * @returns 返回切片操作的结果，具体类型和内容取决于CRUD.SLICEFILE的实现
   */
HTTP.postSliceFile(
  {
    url:'/test',
    params: {b:1},
    body: {
      file：File, // 要上传的文件对象
      chunkSize: number, // 可选的 每个文件块的大小，默认一片为（1024 * 1024 * 2）
      passedBlocks: number[], // 可选的 已上传的文件块序号数组，用于中断续传 与 needBlock 而选一
      needBlock: number[], // 可选的 需要上传的文件块序号数组，用于中断续传 与 passedBlocks 而选一
    },
  }
  (res) => {
    console.log('进度', res)
  }
).then((res) => {
  console.log('res', res.data)
})

path 请求

HTTP.path({
  url:'/test',
  params: {b:1},
  body: {a:2}
}).then((res) => {
  console.log('res', res.data)
})

// 表单
HTTP.pathForm({
  url:'/test',
  body: {a:2}
}).then((res) => {
  console.log('res', res.data)
})

// 上传文件
HTTP.pathFileForm({
  url:'/test',
  params: {b:1},
  body: {a:2， file：File||File[]},
}, (res) => {
  console.log('进度', res)
}).then((res) => {
  console.log('res', res.data)
})

put 请求

HTTP.put({
  url:'/test',
  params: {b:1},
  body: {a:2}
}).then((res) => {
  console.log('res', res.data)
})

// 表单
HTTP.putForm({
  url:'/test',
  body: {a:2}
}).then((res) => {
  console.log('res', res.data)
})

// 上传文件
HTTP.putFileForm({
  url:'/test',
  params: {b:1},
  body: {a:2， file：File||File[]},
}, (res) => {
  console.log('进度', res)
})

connect 请求 建立一个允许后端不断推送信息的连接

const ES = HTTP.connect({
  url:'/test'
}, (res) => {
  console.log('后端推送的信息', res)
}).then((res) => {
  console.log('res', res.data)
})

// 关闭
ES.close()

delete 请求

HTTP.delete({
  url:'/test',
  params: {b:1},
  body: {a:2}
}).then((res) => {
  console.log('res', res.data)
})

head 请求

HTTP.head({
  url:'/test',
  params: {b:1},
})

options 请求

HTTP.options({
  url:'/test',
  params: {b:1},
  body: {a:2}
})