Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tien/regrest
micro http client - modern promise based
https://github.com/tien/regrest
ajax http-client javascript nodejs promise
Last synced: 1 day ago
JSON representation
micro http client - modern promise based
- Host: GitHub
- URL: https://github.com/tien/regrest
- Owner: tien
- License: mit
- Created: 2018-08-17T10:45:59.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2021-06-04T00:21:48.000Z (over 3 years ago)
- Last Synced: 2025-01-03T23:35:22.713Z (3 days ago)
- Topics: ajax, http-client, javascript, nodejs, promise
- Language: TypeScript
- Homepage:
- Size: 1.22 MB
- Stars: 10
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀 Regrest - Micro HTTP client
[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/js/regrest)
[](https://cdn.jsdelivr.net/npm/regrest/lib/index.umd.min.js)
[](https://packagephobia.now.sh/result?p=regrest)
[](https://github.com/prettier/prettier)
Micro Promise based HTTP client for the browser and node.js
## ✨ Features
- Make [XMLHttpRequests](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest) from the browser
- Make [http](http://nodejs.org/api/http.html) requests from node.js
- Supports the [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) API
- Built in [TypeScript](https://www.typescriptlang.org/) support
## 👍🏻 Browser Support
|  |  |  |  |  |  |
| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | 11 ✔ |
### NOTE
If you intend to support Internet Explorer, be sure to have a [poly-fill](https://github.com/taylorhakes/promise-polyfill) that adds a global `Promise` object
## 🏗 Installing
Using npm:
```bash
$ npm install regrest
```
Using cdn:
```html
```
## 🎬 Example
Regrest is designed to be the simplest way possible to make http calls
Performing a `GET` request
```js
// Import using NodeJS or CommonJS module
const regrest = require("regrest").default;
// Or using ES6 module
import regrest from "regrest";
// Use Promise
regrest
.get("/man/bear/pig")
// Print the raw response string
.then((response) => console.log(response.text))
// Print any error if occurred
.catch((error) => console.log(`*** Error: ${error}`));
// Or use the new async/await keywords
const getGood = async () => {
try {
// Store the response in a variable
const response = await regrest.get("/foo/bar.json");
// print out the parsed response
console.log(response.json);
} catch (error) {
// Print any error if occurred
console.log(`*** Error: ${error}`);
}
};
getGood();
// Or use callbacks
// WE DON'T DO THAT HERE
```
Performing a `POST` request
```js
regrest
.post("/comment", JSON.stringify({ name: "Foo", comment: "Bar" }))
.then((response) => console.log(response.status, response.statusText))
.catch((error) => console.log(error));
```
## 📚 Documentation
### Convenience methods
##### regrest.request(options)
##### regrest.get(url[, options])
##### regrest.head(url[, options])
##### regrest.post(url[, data[, options]])
##### regrest.put(url[, data[, options]])
##### regrest.delete(url[, options])
##### regrest.options(url[, options])
##### regrest.patch(url[, data[, options]])
### Options options
```js
// Default options are marked with *
const options = {
method: "GET", // *GET, POST, PUT, DELETE, etc.
url: "https://some-domain.com/api/",
headers: { "Content-Type": "application/json; charset=utf-8" }, // *{}
params: { UID: 9873 },
data: JSON.stringify(data), // *null
maxRedirects: 10, // *5
withCredentials: true, // *false, true
};
```
### Response object attributes
```js
{
// Contains the status code of the response, e.g. 404 for a not found resource, 200 for a success
status: 200,
// A message related to the status attribute, e.g. OK for a status 200
statusText: "OK",
// The headers that the server responded with
headers: {},
// Response content as a string
text: "",
// Response content as JSON
json: {},
// Response content as Blob on browser and Buffer on Node js
arrayBuffer: instance of Blob || instance of Buffer,
// Reponse content as Blob
blob: instance of Blob
};
```
### Errors handling
```js
regrest.get("/McNullington").catch((error) => {
if (error.response) {
/**
* A request was made but server responded
* with status code out of the 2XX range
* `error.response` is an instance of the response object
*/
console.log(error.response.status);
console.log(error.response.statusText);
console.log(error.response.headers);
// ...
} else if (error.request) {
/**
* A request was made, but no response was received
* `error.request` is an instance of XMLHttpRequest on browser and an instance of
* http.ClientRequest on Node js
*/
console.log(error.request);
} else {
// Something else happened
console.log(error.message);
}
});
```