@nanotime/http-please

Http Please

An Fetch API wrapper writen in vainilla JS


· Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Installation
3. Usage
4. Contributing
5. License

About The Project

HttpPlease is a wrapper for Fetch, a TypeScript library that was born as an educational project to learn how to apply design patterns and create NPM packages that are as close to production standards as possible.

The goal of this project is to deploy a small, personal tool that is easy to use and extend, and in which anyone can contribute.

Oh yes! And it works, you can use it for your personal projects, after all it's just fetch...

(back to top)

Getting Started

Let's go, then...

Installation

1. Install the library npm i -D @nanotime/http-please

(back to top)

Usage

Using this library is not different to use any other NPM library, just import it after the install and instance the class:

// Import the lib
import HttpPlease from '@nanotime/http-please';

// Create an instance
const http = new HttpPlease({
  url: 'http://example.com',
  options: { ... } // fetch options
})

// Make a call
http.get({ path: '/foo' }).then(res => console.log(res.data));

// It can be done also with async/await

async function getFoo() {
  const response = await http.get({ path: 'foo' });
  return response;
}

For more examples, please refer to the Documentation

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "feature". Don't forget to give the project a star! Thanks again!

Important note: this project has some strict rules (husky, testing, etc) for commiting and tools to help on it, don't make commits using the git command, instead just run npm run commit, this wil guide you on the correct standard way to commiting in this project. There is also a command npm run branch that can help you to create branch in a proper way.

1. Fork the Project
2. Create your Feature Branch (npm run branch)
3. Commit your Changes (npm run commit')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

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

(back to top)