Http-bee-request NPM

Http Bee Request 🐝

A little tool to make web calling a breeze!✌️

Installation

You can install Http Bee Request using npm

  npm i http-bee-request

Usage

NB: the calls return a promise, so they must be done asynchronously through the `async` and `await` keywords

To use the call, you need to import the module Api both in Javascript and Typescript environment. For the latter it is also necessary to import RequestParams, the type of the object passed as a parameter to the call. In the documentation, use in a vanilla Javascript environment will be taken as an example except in the first case in which the use of RequestParams will also be shown.

Javascript

import { Api } from "http-bee-request";

async function callExample() {
  let params = {
    url: "https://example.com/",
    method: "GET",
  };

  let result = await Api.callGlobal(params);

  console.log(result);
}

Typescript

import { Api, RequestParams } from "http-bee-request";

async function callExample() {
  let params: RequestParams = {
    url: "https://example.com/",
    method: "GET",
  };

  let result = await Api.callGlobal(params);

  console.log(result);
}

These examples above, show the basic use of the library in both Javascript and Typescript projects. It starts with the creation of an object: the url and method keys are required!

With callback function:

import { Api } from "http-bee-request";

async function callExample() {
  let params = {
    url: "https://example.com/",
    method: "GET",
  };

  await Api.callGlobal(params, (result) => {
    console.log(result);
  });
}

The callback function is an optional parameter: it accepts the result of the call as an input parameter.

Body

Not all calls to the server need data to be sent, for this reason body is optional.

Here are some examples of how to use this parameter:

import { Api } from "http-bee-request";

async function callExample() {
  let params = {
    url: "https://example.com/",
    method: "POST",
    body: {
      id: 1,
      name: "Tom",
      surname: "Hanks",
    },
  };

  await Api.callGlobal(params);
}

You can safely store the POST result or use a callback as a parameter.

Status handling

During a call to the server, it may happen that it fails. If this happens, the status value is returned. Let's see some examples:

import { Api } from "http-bee-request";

async function callExample() {
  let params = {
    url: "https://example.com/121",
    method: "GET",
  };

  let res = await Api.callGlobal(params);

  if (res.status == 404) {
    //some code...
  }
}

or you can use callback functions:

import { Api } from "http-bee-request";

async function callExample() {
  let params = {
    url: "https://example.com/121",
    method: "GET",
  };

  await Api.callGlobal(
    params,
    (result) => {
      console.log(result);
    },
    (error) => {
      if (error.status == 404) {
        //some code...
      }
    }
  );
}