cute http Download - cute http Source code download

cute http

Other categories

1.0.0

Download

cute-http

cute-http, a cute http request library, easy to use & simple

You can set the number of retries after request timeout
Caching policies can be set for get requests
Cute has optimized the cache. For a get request of the same URL, if the query parameters remain unchanged, the cached result will be obtained first. If it cannot be retrieved, it will go to the backend to request it. If there is a change, the previous cached result will be deleted and the next one will be retrieved. The client requests new results to prevent too much useless data from being cached.
You can initiate multiple get, multiple post requests, multiple jsonp requests, or multiple different types of requests
For parallel requests, cute has two strategies for processing results.
The default use ensures that the request is executed before the result is returned. Even if an error occurs in one of the requests, it will not affect other requests. Of course, the user needs to traverse the returned result data at this time, because one of them may be an error. Users can also set it so that when multiple requests are initiated, as long as there is an error in one request, all will fail.

How to use

Install cute-http

 npm i cute-http --save

introduce

 import * as cute from 'cute-http';

api

constant

 const {ONE_ERROR_ABORT_ALL, KEEP_ALL_BEEN_EXECUTED, LOCAL_STORAGE, MEMORY} = cute.const;

ONE_ERROR_ABORT_ALL an error, interrupt all requests
KEEP_ALL_BEEN_EXECUTED An error will not affect other requests. The caller needs to handle the returned error by himself.
LOCAL_STORAGE caches get return results in localStorage
MEMORY caches the results returned by get in memory

setConfig

Top-level API, configure parameters for cute

 cute setConfig({
  retryCount: number,//重试次数
  timeout: 1900,//超时时间（毫秒）
  debug:true,//打开debug模式
  // cacheType: MEMORY, // 默认无，如果开启了缓存，cute只针对get请求做缓存，如需穿透缓存，可以对query参数加随机值，或者调用cute.get时，配置第二个参数{cacheType:null}，表示针对这一次调用不读取缓存值
  // failStrategy: ONE_ERROR_ABORT_ALL, //不设置的话，cute默认采用KEEP_ALL_BEEN_EXECUTED
})

multi

 /**
 * 发起多个post请求
 * @param {Array<{type:'post', url:string, data:object} | {type:'get', url:string} | {type:'jsonp', url:string} >} items
 * @param {{failStrategy?:number, retryCount?:number, callbackParamName?:string, [otherAxiosConfigKey]:any}} extendedAxiosConfig
 * otherAxiosConfigKey @see https://github.com/axios/axios
 */
cute.multi(urls, extendedAxiosConfig)

get

 // data 会被自动stringify拼接到url末尾
cute.get(url:string, data:string|object, extendedAxiosConfig:ExtendedAxiosConfig)

multiGet

 cute.multiGet(urls:string[] | {url:string, data:string|object}[], extendedAxiosConfig:ExtendedAxiosConfig)

post

 cute.post(url:string, data:object, extendedAxiosConfig:ExtendedAxiosConfig)

multiPost

 cute.multiPost({url:string, data:object}[], extendedAxiosConfig:ExtendedAxiosConfig)

jsonp

 // data 会被自动stringify拼接到url末尾
cute.jsonp(url:string, data:string|object, extendedAxiosConfig:ExtendedAxiosConfig)

multiJsonp

 cute.multiJsonp(urls:string[] | {url:string, data:string|object}[], extendedAxiosConfig:ExtendedAxiosConfig)

The following code is in test/test-api.js. Users can execute node ${your_test_dir}/test-api.js to see the effect.

Of course, you can also comment out certain codes and only see the effect of one of them

 const cute = require('../index');
const {ONE_ERROR_ABORT_ALL, KEEP_ALL_BEEN_EXECUTED, MEMORY} = cute.const;
const axios = cute.axios;//这个是axios模块的引用

cute.setConfig({
  retryCount: 3,//设置重试次数
  timeout: 1900,//设置超时时间
  debug: true,
  dataVerifyRule: {//设置通用的响应数据校验规则，只支持校验json对象的第一层key的值和类型的校验
    data: 'object',
    code: 'number',
    message: 'string',
  },
  pathDataVerifyRule:{//对某些请求设置独立的数据校验规则
    '/staff/foo':{
      reply:'object',
      msg:'string',
    }
  }
  cacheType: MEMORY, // 值为 'memory' | 'localStorage' 默认无
  failStrategy: KEEP_ALL_BEEN_EXECUTED, //不设置的话，cute默认采用ONE_ERROR_ABORT_ALL
})

const updateBook = 'http://localhost:8888/update-book';
const getBooksByUid = uid => `http://localhost:8888/get-books?uid=${uid}`;

async function main(){
  const result1 = await cute.get(getBooksByUid(1));
  const books = result.result1;

  const result2 = await cute.multiGet([getBooksByUid(1), getBooksByUid(2)]);
  const [reply1, reply2] = result2;

  const result3 = await cute.post(updateBook, {id:1, name:'zk'});
  const updateReply = result.result3;

  const result4 = await cute.multiPost([{url:updateBook, body:{id:1, name:'zk'}}, {url:updateBook, body:{id:2, name:'wow'}}]);
  const [updateReply1, updateReply2] = result4;

}