@burstjs/http v0.6.0-beta.6

@burstjs/http

Generic HTTP client that is used as a network provider for @burst/core.

Installation

@burstjs/http can be used with NodeJS or Web. Two formats are available

Using with NodeJS and/or modern web frameworks

Install using npm:

npm install @burstjs/http

or using yarn:

yarn add @burstjs/http

Example

import {HttpImpl} from '@burstjs/http'

try{
    const client = new HttpImpl('https://jsonplaceholder.typicode.com/');
    const response = client.get('/todos/1')
    console.log(response)
}
catch(httpError){
    console.error(httpError.message)
}

Using in classic <script>

Each package is available as bundled standalone library using IIFE. This way burstJS can be used also within <script>-Tags. This might be useful for Wordpress and/or other PHP applications.

Just import the package using the HTML <script> tag.

<script src='https://cdn.jsdelivr.net/npm/@burstjs/http/dist/burstjs.http.min.js'></script>

Example

const client = new b$http.HttpImpl('https://jsonplaceholder.typicode.com/');
client.get('/todos/1').then(console.log)

See more here:

@burstjs/http Online Documentation

API Reference

Modules

http

• http
  • ~HttpImpl
    • new HttpImpl(baseURL, options)
    • .mountError(url, error)

http~HttpImpl

Kind: inner class of http

• ~HttpImpl
  • new HttpImpl(baseURL, options)
  • .mountError(url, error)

new HttpImpl(baseURL, options)

HttpImpl.mountError(url, error)

Kind: static method of HttpImpl
Internal:

http

• http
  • ~HttpImpl
    • new HttpImpl(baseURL, options)
    • .mountError(url, error)

http~HttpImpl

Kind: inner class of http

• ~HttpImpl
  • new HttpImpl(baseURL, options)
  • .mountError(url, error)

new HttpImpl(baseURL, options)

HttpImpl.mountError(url, error)

Kind: static method of HttpImpl
Internal:

http

Internal: Http Mocker for easy to http testing using Jest

When using this mocking helper you need to call Http.onGet() before Http instance is created

• http
  • ~HttpImpl
    • new HttpImpl(baseURL, options)
    • .mountError(url, error)

http~HttpImpl

Kind: inner class of http

• ~HttpImpl
  • new HttpImpl(baseURL, options)
  • .mountError(url, error)

new HttpImpl(baseURL, options)

HttpImpl.mountError(url, error)

Kind: static method of HttpImpl
Internal:

http

const response = await mockedHttp.get('/url');

await mockedHttp.post('/url/post', {faz: 'post'}); // will throw exception

• http
  • ~HttpImpl
    • new HttpImpl(baseURL, options)
    • .mountError(url, error)

http~HttpImpl

Kind: inner class of http

• ~HttpImpl
  • new HttpImpl(baseURL, options)
  • .mountError(url, error)

new HttpImpl(baseURL, options)

HttpImpl.mountError(url, error)

Kind: static method of HttpImpl
Internal:

http

• http
  • ~HttpImpl
    • new HttpImpl(baseURL, options)
    • .mountError(url, error)

http~HttpImpl

Kind: inner class of http

• ~HttpImpl
  • new HttpImpl(baseURL, options)
  • .mountError(url, error)

new HttpImpl(baseURL, options)

HttpImpl.mountError(url, error)

Kind: static method of HttpImpl
Internal:

http

• http
  • ~HttpImpl
    • new HttpImpl(baseURL, options)
    • .mountError(url, error)

http~HttpImpl

Kind: inner class of http

• ~HttpImpl
  • new HttpImpl(baseURL, options)
  • .mountError(url, error)

new HttpImpl(baseURL, options)

HttpImpl.mountError(url, error)

Kind: static method of HttpImpl
Internal: