About The Project

I want to create a lightweight HTTP request so amazing that it'll be the first one pick -- I think it will.

Here's why:

• Lightweight Node.js HTTP request library
• Promise based requests with easy to use interface

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• Follow Redirects

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/laynef/Fast-Node-HTTP-Requests.git

2. Install NPM packages

   npm install -S fast-http-request

Usage

Parameters:

• Url: string
• Body: Must be string. Use JSON.stringify for any objects used.
• Options: Must be an object. Check Node.js request options

Methods

• GET:

request.get(url: string, options = {})

• POST:

request.post(url: string, body: string, options = {});

• PATCH:

request.patch(url: string, body: string, options = {});

• PUT:

request.put(url: string, body: string, options = {});

• DELETE:

request.delete(url: string, options = {});

Responses

• Succesful Returns

{ headers: {}, body: {}, statusCode: number }

• Error Returns

{ headers: {}, body: {}, statusCode: number }

Examples

• GET:

const request = require("http-fast-request");

async function () {
    try {
        const response = await request.get(url = "", options = {});
        // Response: { headers: {}, body: {}, statusCode: number }
        return response.body;
    } catch (error) {
        // Error Response: { headers: {}, body: {}, statusCode: number }
        return error;
    }
}

• POST:

const request = require("http-fast-request");

async function () {
    try {
        const response = await request.post(url = "", body = "{}", options = {});
        // Response: { headers: {}, body: {}, statusCode: number }
        return response.body;
    } catch (error) {
        // Error Response: { headers: {}, body: {}, statusCode: number }
        return error;
    }
}

• PATCH:

const request = require("http-fast-request");

async function () {
    try {
        const response = await request.patch(url = "", body = "{}", options = {});
        // Response: { headers: {}, body: {}, statusCode: number }
        return response.body;
    } catch (error) {
        // Error Response: { headers: {}, body: {}, statusCode: number }
        return error;
    }
}

• PUT:

const request = require("http-fast-request");

async function () {
    try {
        const response = await request.put(url = "", body = "{}", options = {});
        // Response: { headers: {}, body: {}, statusCode: number }
        return response.body;
    } catch (error) {
        // Error Response: { headers: {}, body: {}, statusCode: number }
        return error;
    }
}

• DELETE:

const request = require("http-fast-request");

async function () {
    try {
        const response = await request.delete(url = "", options = {});
        // Response: { headers: {}, body: {}, statusCode: number }
        return response.body;
    } catch (error) {
        // Error Response: { headers: {}, body: {}, statusCode: number }
        return error;
    }
}

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - [email protected]

Project Link: https://github.com/laynef/Fast-Node-HTTP-Requests

Acknowledgements

• Follow Redirects