http-request-client

3.2.0 • Public • Published

Repository

https://github.com/reecemillsom/http-request-client

codecov codecov codecov

Point to Note

This project uses XMLHttpRequest from the window and the fetch function depending on which request you do, so as long as your projects have access to the DOM this will work.

Installation and Usage

  1. npm i --save http-request-client
  2. import { Get, Head, Patch, Post, Put, Del, Fetch, XMLHttpFactory, FetchRequestFactory } from "http-request-client";

For all XMLHttpRequest types e.g. Get, Head, Patch, Post, Put, Del:

    const xmlHttpFactory = new XMLHttpFactory(XMLHttpRequest);
    const get = new Get(xmlHttpFactory);

For Fetch:

    const requestFactory = new FetchRequestFactory(Request);
    const fetch = new Fetch(requestFactory, window);

All of the above have a handleRequest function that is the entry for all requests which can be called once the request class is instantiated.

GET, POST, PATCH, PUT, DELETE, HEAD request

GET request tries to parse the response to JSON, if this fails it will return the whole response anyways.

For Request types get, post, patch, put, delete, head a handleRequest function should be called which returns a promise result or error. The function has 3 params but only one is required.

Params are:

  1. Url type string required. This is the url you want to do a request to.
  2. Headers type object. This is if you have headers you wish to set when doing a request.
  3. Data you wish to send. This is if you have data to send along with the request. Typically when using a put or post request. Please stringify data before passing as a param.

Example of how to pass headers:

{"Content-type": "application/x-www-form-urlencoded"}

Fetch request

Fetch request will try to parse the response to JSON, if not it will return the whole response. This means if your content isn't json you can call .blob(), .text() and more for what you need.

Request type fetch has a handleRequest function which returns a promise result or error. This function only has 2 params.

Params are:

  1. Url type string required. This is the url you want to do a request to.
  2. Options type object. This is to be able to change type of request e.g. POST, GET or maybe change cache rules etc. To see full list of options visit: https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch and look at the init param options. By default fetch request does a GET request.

If using fetch be aware the current support of this function is for more recent browser versions, so use it if your not bothered about supporting older versions or do not need certain functionality.

Examples of requests

In order to test these requests you can clone the respository. I created a browserified bundle which gets attached to the window.

In order to test follow these steps:

  1. Run npm run browserify - This will output a file in the browserify directory called TestRequests.
  2. Open the html file located in the scripts directory in the browser - TestRequests.html.
  3. Open the developer console.
  4. Type requests and hit enter. You will see the instance for the corresponding requests are attached.
  5. Each instance has a handleRequest function as described earlier, fill the parameters as necessary and call the function.

Issues

If you find an issue please feel free to contact me, or open an issue on the project and I will look.

Package Sidebar

Install

npm i http-request-client

Weekly Downloads

2

Version

3.2.0

License

ISC

Unpacked Size

881 kB

Total Files

70

Last publish

Collaborators

  • rmillsom