@cqlinkoff/request v1.3.0

request

http request based on fetch api

Installation

npm i @cqlinkoff/request

Use

import Request from '@cqlinkoff/request'

const request = new Request(options)

API

new Request(options)

create a request instance

• options:
  • options.baseURL: base url
  • options.headers: default headers
  • options.beforeRequest: will be called before request, you can handle with request config and return a new config, support Promise
  • options.afterRequest: will be called after request, you can handle with response and return it, support Promise

request.request(url, requestOptions)

basic http request

• url: string or object, if it's object, it will be treated as requestOptions, see requestOptions
• requestOptions: see requestOptions

request.get(url, requestOptions): Promise<any>

request use GET

request.post(url, requestOptions): Promise<any>

request use POST

request.put(url, requestOptions): Promise<any>

request use PUT

request.patch(url, requestOptions): Promise<any>

request use PATCH

request.del(url, requestOptions): Promise<any>

request use DELETE

requestOptions

request config

• url: string

  resource url, it will be automatically added after baseURL if you set it in constructor, support params

• query: object

  query params, it will be automatically added after url

• body: object

  request body, if request method is GET, it's same as query

• params: object

  url params will be automatically replaced based on params, such as /{id} will be replaced by params.id

• headers: object

  request headers

TODO

• unit test
• flow support