Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itokun99/http
Fetch Utils without pain
https://github.com/itokun99/http
api fetch-api javascript
Last synced: about 2 months ago
JSON representation
Fetch Utils without pain
- Host: GitHub
- URL: https://github.com/itokun99/http
- Owner: itokun99
- Created: 2024-05-07T16:55:12.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-09-07T04:29:32.000Z (4 months ago)
- Last Synced: 2024-11-08T13:43:49.943Z (about 2 months ago)
- Topics: api, fetch-api, javascript
- Language: TypeScript
- Homepage:
- Size: 50.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @itokun99/http
A utility for making API requests easily and efficiently.
## Installation
To install this package, run the following command:
```bash
npm install @itokun99/http
```
## Usage
Here's how to use this package in your project.
### Import Module
```javascript
const http = require("@itokun99/http");
```
### GET Request
```javascript
http
.get("https://api.example.com/data")
.then((response) => {
console.log("Data:", response.data);
})
.catch((error) => {
console.error("Error:", error);
});
```
### POST Request
```javascript
const data = { key: "value" };
http
.post("https://api.example.com/data", data)
.then((response) => {
console.log("Response:", response.data);
})
.catch((error) => {
console.error("Error:", error);
});
```
### PUT Request
```javascript
const updatedData = { key: "newValue" };
http
.put("https://api.example.com/data/1", updatedData)
.then((response) => {
console.log("Updated Response:", response.data);
})
.catch((error) => {
console.error("Error:", error);
});
```
### DELETE Request
```javascript
http
.delete("https://api.example.com/data/1")
.then((response) => {
console.log("Delete Response:", response.data);
})
.catch((error) => {
console.error("Error:", error);
});
```
## API
### Methods
#### `get(url, [options])`
Performs an HTTP GET request to the specified URL.
**Parameters:**
- `url` (string): The URL endpoint to request.
- `options` (object, optional): Additional configuration for the request.
**Returns:**
- Promise: Resolves with the response data or rejects with an error.
#### `post(url, data, [options])`
Performs an HTTP POST request to the specified URL with the provided data.
**Parameters:**
- `url` (string): The URL endpoint to request.
- `data` (object): The data to send in the request body.
- `options` (object, optional): Additional configuration for the request.
**Returns:**
- Promise: Resolves with the response data or rejects with an error.
#### `put(url, data, [options])`
Performs an HTTP PUT request to the specified URL with the provided data.
**Parameters:**
- `url` (string): The URL endpoint to request.
- `data` (object): The data to send in the request body.
- `options` (object, optional): Additional configuration for the request.
**Returns:**
- Promise: Resolves with the response data or rejects with an error.
#### `delete(url, [options])`
Performs an HTTP DELETE request to the specified URL.
**Parameters:**
- `url` (string): The URL endpoint to request.
- `options` (object, optional): Additional configuration for the request.
**Returns:**
- Promise: Resolves with the response data or rejects with an error.
## Contributing
If you would like to contribute to this project, please follow these steps:
1. Fork this repository.
2. Create a new feature branch (`git checkout -b new-feature`).
3. Commit your changes (`git commit -am 'Add new feature'`).
4. Push to the branch (`git push origin new-feature`).
5. Create a Pull Request.
## License
This package is licensed under the [MIT License](LICENSE).
---
For more information, visit the [GitHub repository](https://github.com/itokun99/http).
```
Feel free to let me know if there are any other adjustments you would like to make!
```