Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 2.55 KB

en.README.md

File metadata and controls

66 lines (42 loc) · 2.55 KB
Raw

umi-request-cancel

umi-request cancel lib, you can easy cancel your request.

Chinese documents|English documents

NPM version

Installation

yarn add umi-request-cancel
npm install --save umi-request-cancel

ExtraOptions

Parameter Description Type Optional Value Default Value
cancelKey cancel request unique ID, top level String
urlUnique cancel request compare with URL String | Regexp 'host'、'path'、'search'、RegExp
urlBase URL constructor params DOMString window.location.origin
urlUniqueList list to match, it can be use with urlUnique to match url Array

OptionDetail

urlUnique

  • -- host [string]

    compare with host, If it is the same, cancel the previous request.

  • -- path [string]

    compare with host and pathname, If it is the same, cancel the previous request.

  • -- search [string]

    compare with host and pathname and search, If it is the same, cancel the previous request.

  • -- RegExp [RegExp]

    compare href address with regexp, If it is test true, cancel the previous request.

Example

import request, { extend } from "umi-request-cancel";

const req = extend({
  timeout: 3000,
  urlBase: process.env.NODE_ENV === 'development' ? 'http://localhost': ''
  urlUnique: 'search'
})

/* cancelKey */
request
  .get("/api/v1/xxx?id=1", {
    cancelKey: "cancelKey1", // 第一优先级
  })

Thanks

umi-request