npm.io
2.0.0 • Published 5 years ago

orcrist-request

Licence
ISC
Version
2.0.0
Deps
0
Size
51 kB
Vulns
0
Weekly
0

orcrist request Ajax 请求功能组件

Update Log

  • v1.9.x 添加 FormData 文件上传兼容处理
  • v1.8.x 添加默认请求 30s 熔断功能
  • v1.5.x 添加接口 500 异常处理

Install

npm install --save orcrist-request

Usage

Default JSON Content-Type: application/json

import request from "orcrist-request";
// GET
const reqPromise = request("http://www.test.com/api/citys", {
  method: "get", // post 兼容大小写
  body: {
    foo: "bar",
  }, // Body数据部分会自动拼接至URL后
});

// POST
const req2Promise = request("http://www.test.com/api/citys", {
  method: "POST", // post 兼容大小写
  body: {
    foo: "bar",
  },
});

reqPromise.then((data) => data).catch((error) => console.error(error));
reqPromise2.then((data) => data).catch((error) => console.error(error));

FormData ver. (文件上传)

// POST
const formReqPromise = request("http://www.test.com/api/fileUpload", {
  method: "POST", // post 兼容大小写
  type: "FORM", // form 兼容大小写
  body: {
    files: {}, // dom -> files[0]
  }, // formData.append('files', {})
});

formReqPromise.then((data) => data).catch((error) => console.error(error));

API

参数 说明 类型 默认值
url 请求 URL String
option 操作 Object Option Object
handle 控制 Object Handle Object
Option Object
参数 说明 类型 默认值 可选值
method 请求方法类型 String 'get' 'get' / 'post'
type 发送数据类型 String 'json' 'json' / 'form'
headers 自定义请求 Header 头信息 Object
body 请求发送数据 Object
Handle Object
参数 说明 类型 默认值
timeout 请求 API 熔断超时限制,单位秒 Number 30

Keywords