prhttp

2.1.3 • Public • Published

prhttp

A JavaScript HTTP interceptor inspired by okhttp

Installation

npm install prhttp

Usage

Create HTTP engine

Create an object which implement execute function

class exampleEngine() {
    execute(request) {
        //execute http request
    }
}

Create interceptor

Create an ojbect which implement intercept function

class exampleInterceptor() {
    async intercept(chain) {
        const newRequest = chain.request.newRequest()
        newRequest.setHeader('Authorization', 'your token')
        return await chain.proceed(newRequest)
    }
}

Send Http request

import { PrHttpClientBuilder, PrRequestBuilder}  from 'prhttp'

let builder = new PrHttpClientBuilder()
let httpClient = builder.setEngine(new exampleEngine())
                        .addInterceptor(new exampleInterceptor)
                        .build()

let getBuilder = new PrRequestBuilder()
getBuilder.setMethod('get')
              .setBaseUrl("https://www.example.com")
              .setContentType('application/json')

let request = getBuilder.build()
const data = {
    data1: 'data'
}
request.setUrl('your api').setData(data)

httpClient.newCall(request).execute()

Cancellation

You can cancel a request Using Call.cancel(). Instead of normal return , CancelError will be thrown.

const call = httpClient.newCall(request)
call.execute().then(res => {
    console.log(res)
}).catch( e => {
    if(e instanceof CancelError) {
        console.log('Request was cancelled')
    } else {
        console.log(e)
    }
})

setTimeout( () => {
    call.cancel()
}, 100)

Lifecycle Binding

PrHttpClient instance can be bound to a lifecycle. When the state of lifecycle is BEFORE_UNMOUNTED, Call.cancel() will be call.

Example

You can look at a full example which use Axios as engine

Package Sidebar

Install

npm i prhttp

Weekly Downloads

0

Version

2.1.3

License

MIT

Unpacked Size

11.3 kB

Total Files

17

Last publish

Collaborators

  • idleray