Code Monkey home page Code Monkey logo

request's Introduction

request · LICENSE codecov

This is just a request library to support browsers and MiniProgram platforms.

Include

yarn add @huolala-tech/request

or

npm install @huolala-tech/request --save

Params

name type description
method (required) string Request method
url (required) string Request URL
data any Request payload (or query string for GET/HEAD methods)
timeout number Request timeout in milliseconds
headers Record<string, string> Request header
files Record<string, Blob | File | string> Payload files
responseType text | json | arraybuffer | blob | document Response type
withCredentials boolean The withCredentials flag for XHR object
signal AbortSignal An abort signal like fetch
onUploadProgress (info: { total: number, loaded: number }) => void The uploading progress event

NOTE 1: The method field

  1. Some MiniProgram platforms can only support "GET" or "POST" methods, so using a RESTful API is not the best solution for MiniPrograms.

NOTE 2: The files field

  1. In browsers, the file is represented as a Blob or File object, whereas in other MiniProgram platforms, the file is represented as a string filePath.
  2. MiniProgram platforms doese not suport multiple files uploading in once.

NOTE 3: The responseType field

  1. The values of blob and document can only be used on browser.
  2. The responseType can not be used with files on MiniProgram platforms.

NOTE 4: The withCredentials field

  1. This can only be used on browser.

Return Promise<InvokeResult>

The InvokeResult is

name type description
statusCode number Response status code
data any Response body
headers Record<string, string> Response headers

Demo

import { request } from '@huolala-tech/request';

async function main() {
  const res = await request({
    method: 'POST',
    url: 'http://localhost/api',
    data: {
      xxx: 'xxx',
    },
  });

  if (res.statusCode === 200) {
    console.log(res.data);
  }
}

Advanced Features

1. Interceptors

Taking into account the learning cost, our interceptors API design is modeled after the Axios.

import { request, interceptors } from '@huolala-tech/request';

// Add Authorization: xxx header for all requests.
interceptors.request.use((req) => {
  req.headers = { ...Object(req.headers), Authorization: 'xxx' };
});

// If any request responds with a 401 code, go to login.
interceptors.response.use((res) => {
  if (res.statusCode === 401) {
    location.href = 'http://blahblahblah/';
  }
});

request({ method: 'POST', url: 'http://localhost/api/user' });

2. New Instance

You can use create method to create a pairs request and intercepters and set a common request parameters.

import { create } from '@huolala-tech/request';
const { request, interceptors } = create({
  header: {
    'x-request-with': '@huolala-tech/request'
  }
});

// TODO

NOTE: The created pairs is an isolated instance, global intercepters will not act on the created request.

request's People

Contributors

cloverstd avatar yanagieiichi avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

request's Issues

百度小程序环境判断

百度小程序运行环境里会包含 window 和 XMLHttpRequest,会误判为 浏览器,但实际调不通。

src/internalRequest.ts

(百度其实可以不支持,没啥人用了

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.