@burstjs/contracts

@burstjs/contracts

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

Installation

@burstjs/contracts 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/contracts

or using yarn:

yarn add @burstjs/contracts

Example

// TO DO

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

// TO DO

See more here:

@burstjs/contracts Online Documentation

---

API Reference

Modules

http

Classes

HttpImpl

Generic Http client

http

• http
  • ~HttpError
  • ~HttpMock
    • .onGet(endpoint?)
    • .onPost(endpoint?)
    • .onPut(endpoint?)
    • .onDelete(endpoint?)
    • .reset()
  • ~HttpResponse

http~HttpError

HttpError class

Thrown on HTTP errors

Kind: inner class of http

http~HttpMock

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

Kind: inner class of http

• ~HttpMock
  • .onGet(endpoint?)
  • .onPost(endpoint?)
  • .onPut(endpoint?)
  • .onDelete(endpoint?)
  • .reset()

HttpMock.onGet(endpoint?)

Mocks responses for get methods You may pass a specific endpoint as parameter to mock only selected endpoints. This is very useful, when having methods that do several Http requests, so you can mock them one on one.

The following code returns the same content on every get call

  HttpMock.onGet().reply(200, [{login: 'foo'}, {login: 'bar'}]);

The next code returns the different content depending on the passed endpoint

  HttpMock.onGet('/foo').reply(200, {data: 'foo'});
  HttpMock.onGet('/bar').reply(200, {data: 'bar'});

Kind: static method of HttpMock

Param	Description
endpoint?	An endpoint, to allow specific behavior on that endpoint

HttpMock.onPost(endpoint?)

Mocks responses for post methods

Kind: static method of HttpMock

Param	Description
endpoint?	An endpoint, to allow specific behavior on that endpoint

HttpMock.onPut(endpoint?)

Mocks responses for put methods

Kind: static method of HttpMock

Param	Description
endpoint?	An endpoint, to allow specific behavior on that endpoint

HttpMock.onDelete(endpoint?)

Mocks responses for delete methods

Kind: static method of HttpMock

Param	Description
endpoint?	An endpoint, to allow specific behavior on that endpoint

HttpMock.reset()

Resets all mocked behavior

Kind: static method of HttpMock

http~HttpResponse

Http Response

Returned by Http request

Kind: inner class of http

http

• http
  • ~HttpError
  • ~HttpMock
    • .onGet(endpoint?)
    • .onPost(endpoint?)
    • .onPut(endpoint?)
    • .onDelete(endpoint?)
    • .reset()
  • ~HttpResponse

http~HttpError

HttpError class

Thrown on HTTP errors

Kind: inner class of http

http~HttpMock

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

Kind: inner class of http

• ~HttpMock
  • .onGet(endpoint?)
  • .onPost(endpoint?)
  • .onPut(endpoint?)
  • .onDelete(endpoint?)
  • .reset()

HttpMock.onGet(endpoint?)

Mocks responses for get methods You may pass a specific endpoint as parameter to mock only selected endpoints. This is very useful, when having methods that do several Http requests, so you can mock them one on one.

The following code returns the same content on every get call

  HttpMock.onGet().reply(200, [{login: 'foo'}, {login: 'bar'}]);

The next code returns the different content depending on the passed endpoint

  HttpMock.onGet('/foo').reply(200, {data: 'foo'});
  HttpMock.onGet('/bar').reply(200, {data: 'bar'});

Kind: static method of HttpMock

Param	Description
endpoint?	An endpoint, to allow specific behavior on that endpoint

HttpMock.onPost(endpoint?)

Mocks responses for post methods

Kind: static method of HttpMock

Param	Description
endpoint?	An endpoint, to allow specific behavior on that endpoint

HttpMock.onPut(endpoint?)

Mocks responses for put methods

Kind: static method of HttpMock

Param	Description
endpoint?	An endpoint, to allow specific behavior on that endpoint

HttpMock.onDelete(endpoint?)

Mocks responses for delete methods

Kind: static method of HttpMock

Param	Description
endpoint?	An endpoint, to allow specific behavior on that endpoint

HttpMock.reset()

Resets all mocked behavior

Kind: static method of HttpMock

http~HttpResponse

Http Response

Returned by Http request

Kind: inner class of http

http

• http
  • ~HttpError
  • ~HttpMock
    • .onGet(endpoint?)
    • .onPost(endpoint?)
    • .onPut(endpoint?)
    • .onDelete(endpoint?)
    • .reset()
  • ~HttpResponse

http~HttpError

HttpError class

Thrown on HTTP errors

Kind: inner class of http

http~HttpMock

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

Kind: inner class of http

• ~HttpMock
  • .onGet(endpoint?)
  • .onPost(endpoint?)
  • .onPut(endpoint?)
  • .onDelete(endpoint?)
  • .reset()

HttpMock.onGet(endpoint?)

Mocks responses for get methods You may pass a specific endpoint as parameter to mock only selected endpoints. This is very useful, when having methods that do several Http requests, so you can mock them one on one.

The following code returns the same content on every get call

  HttpMock.onGet().reply(200, [{login: 'foo'}, {login: 'bar'}]);

The next code returns the different content depending on the passed endpoint

  HttpMock.onGet('/foo').reply(200, {data: 'foo'});
  HttpMock.onGet('/bar').reply(200, {data: 'bar'});

Kind: static method of HttpMock

Param	Description
endpoint?	An endpoint, to allow specific behavior on that endpoint

HttpMock.onPost(endpoint?)

Mocks responses for post methods

Kind: static method of HttpMock

Param	Description
endpoint?	An endpoint, to allow specific behavior on that endpoint

HttpMock.onPut(endpoint?)

Mocks responses for put methods

Kind: static method of HttpMock

Param	Description
endpoint?	An endpoint, to allow specific behavior on that endpoint

HttpMock.onDelete(endpoint?)

Mocks responses for delete methods

Kind: static method of HttpMock

Param	Description
endpoint?	An endpoint, to allow specific behavior on that endpoint

HttpMock.reset()

Resets all mocked behavior

Kind: static method of HttpMock

http~HttpResponse

Http Response

Returned by Http request

Kind: inner class of http

HttpImpl

Generic Http client

Kind: global class

new HttpImpl(baseURL, options)

Creates your Http client

Param	Description
baseURL	The baseUrl, i.e host url
options	[optional] An options/configurations object applied to all requests The current implementation uses axios, so the options can be found here Axios Configuration