quickfetch v1.0.0-alpha.5

QuickFetch

a fetch wrapper like axios, support middlewares & abort

1. How to install

npm i quickfetch --save

2. How to use

see test/QuickFetch.test.js

OR vue-cli-3-preset

3. API

Classes

Typedefs

QuickFetch ⇐ MiddlewareHolder

QuickFetch

Kind: global class
Extends: MiddlewareHolder

• QuickFetch ⇐ MiddlewareHolder
  • new QuickFetch([option])
  • instance
    • .get(url, [params], [option]) ⇒ Promise
    • .post(url, [params], [option]) ⇒ Promise
    • .delete(url, [params], [option]) ⇒ Promise
    • .put(url, [params], [option]) ⇒ Promise
    • .patch(url, [params], [option]) ⇒ Promise
    • .sequence(requestPromiseArr) ⇒ Array.<Response>
    • .use(type, middleware, [fetchId]) ⇒ object
  • static
    • .REQUEST
    • .RESPONSE
    • .ERROR
    • .EXCEPTION_TIMEOUT
    • .EVENT_FETCH_ABORT
    • .abort(id)

new QuickFetch(option)

a fetch-based HTTP request tool

quickFetch.get(url, params, option) ⇒ Promise

make a GET fetch

Kind: instance method of QuickFetch
Returns: Promise - a Promise that resolves to a Response object
See: QuickFetch#constuctor

quickFetch.post(url, params, option) ⇒ Promise

make a POST fetch

Kind: instance method of QuickFetch
Returns: Promise - a Promise that resolves to a Response object

quickFetch.delete(url, params, option) ⇒ Promise

make a DELETE fetch

Kind: instance method of QuickFetch
Returns: Promise - a Promise that resolves to a Response object

quickFetch.put(url, params, option) ⇒ Promise

make a PUT fetch

Kind: instance method of QuickFetch
Returns: Promise - a Promise that resolves to a Response object

quickFetch.patch(url, params, option) ⇒ Promise

make a PATCH fetch

Kind: instance method of QuickFetch
Returns: Promise - a Promise that resolves to a Response object

quickFetch.sequence(requestPromiseArr) ⇒ Array.<Response>

make batch requests

Kind: instance method of QuickFetch

quickFetch.use(type, middleware, fetchId) ⇒ object

regist a middleware

Kind: instance method of QuickFetch
Returns: object - actions - { unuse, pause, resume }

QuickFetch.REQUEST

Kind: static property of QuickFetch

QuickFetch.RESPONSE

Kind: static property of QuickFetch

QuickFetch.ERROR

Kind: static property of QuickFetch

QuickFetch.EXCEPTION_TIMEOUT

Kind: static property of QuickFetch

QuickFetch.EVENT_FETCH_ABORT

Kind: static property of QuickFetch

QuickFetch.abort(id)

cancel a fetch action

Kind: static method of QuickFetch

MiddlewareHolder ⇐ EventTarget

MiddlewareHolder

Kind: global class
Extends: EventTarget

middlewareHolder.use(type, middleware, fetchId) ⇒ object

regist a middleware

Kind: instance method of MiddlewareHolder
Returns: object - actions - { unuse, pause, resume }

option : Object | Null

an optional object for Request API

Kind: global typedef
Properties