This module is work-in-progress

That means that the entire module is not finished, and some functionality might not work properly

simple-http-requests NPM module

This is a module made by HyperKNF, with the objective of making HTTP requests in Node.js easier and less complicated.

The module is a wrapper over the 'node-fetch' API.

How to install

Run this in your terminal or command prompt:

npm install simple-http-requests

Then you can import it with:

const { Requests, Headers } = require("simple-http-requests")

Please be noted that the ES way of importing module does not work since I have not implemented it

Example

const response = await Requests.get("https://projects.hyperknf.com/", {})

Requests.get("https://projects.hyperknf.com/", {}).then(response => { /* code */ })

This creates a new request to "https://projects.hyperknf.com/" (which is my website) without any headers and returns a response, so we will need to await it, which requires async, or use .then(), to wait for the response

response.time

This is the time information of the request

response.data

This is the data response from the request

const text = await response.data.text()

response.data.text().then(text => { /* code */ })

This takes the response and turns it into text

const text = await response.data.json()

response.data.json().then(text => { /* code */ })

This takes the response and turns it into a JSON object

Requests class

constructor(type: string, url: string, headers: Headers || object, data: any)

Creates a request

type - The type of HTTP request

url - The URL of the request, starting with https

headers - The headers of the request, Headers object or JSON object

data - The data for the request

returns: Promise<{ time: number, data: Response }>

Requests.get(url: string, headers: Headers || object)

Same as new Requests("get", url, headers)

Requests.post(url: string, headers: Headers || object, data: any)

Same as new Requests("post", url, headers, data)

Requests.delete(url: string, headers: Headers || object, data: any)

Same as new Requests("delete", url, headers, data)

Requests.patch(url: string, headers: Headers || object, data: any)

Same as new Requests("patch", url, headers, data)

Requests.put(url: string, headers: Headers || object, data: any)

Same as new Requests("put", url, headers, data)

Headers class

You will need to set a header for your data type yourself

constructor({name: string, value: string}[, {name: string, value: string}[, ...]}])

Creates a Headers object

name - Name of the header

value - Value of the header

Headers.process(header: Headers)

Processes a Headers object and turns it into a JSON object

headers - The Headers object

Headers.prototype.add({name: string, value: string}[, {name: string, value: string}[, ...]}])

Adds (a) header(s) to an existing Headers object

name - Name of the header

value - Value of the header