Emd-rest NPM | npm.io

emd-rest 🚀

npm Travis (.org) license npm downloads node version GitHub code size in bytes GitHub top language GitHub last commit GitHub issues

DESCRIPTION: Introducing a refined HTTP client experience, our library takes inspiration from Axios, providing all its powerful features, but with an added twist. Our library seamlessly integrates advanced logging capabilities. Every request and response, along with relevant metadata, is conveniently printed to the console, making debugging and tracking easier than ever. For developers who seek clarity and transparency in their HTTP requests without additional setup, this is the tool to elevate your development workflow.

📦 Installation

npm install emd-rest

yarn add emd-rest

💡 Examples

To get started with emd-rest, import it in your project:

const restHelper = require('emd-rest');

import restHelper from 'emd-rest';

Example usage:

restHelper.get("https://jsonplaceholder.typicode.com/todos/1", {params: {id: 1}})
.then( res => console.log(res))
.catch( err => console.log(err));

in async await function:

async function getTodo() {
    try {
        const res = await restHelper.get("https://jsonplaceholder.typicode.com/todos/1", {params: {id: 1}});
        console.log(res);
    } catch (err) {
        console.log(err);
    }
}

arrow function async await:

const getTodo = async () => {
    try {
        const res = await restHelper.get("https://jsonplaceholder.typicode.com/todos/1", {params: {id: 1}});
        console.log(res);
    } catch (err) {
        console.log(err);
    }
}

POST request with data and config:

const data = {
    title: 'foo',
    body: 'bar',
    userId: 1,
};

const config = {
    timeout: 1000,
    withCredentials: true,
    httpsAgent: new https.Agent({ keepAlive: true }),
};

restHelper.post("https://jsonplaceholder.typicode.com/posts", data, config)
.then( res => console.log(res))
.catch( err => console.log(err));

PUT request with headers and data:

const headers = {
    'Content-type': 'application/json; charset=UTF-8',
};

const data = {
    title: 'foo',
    body: 'bar',
    userId: 1,
};

restHelper.put("https://jsonplaceholder.typicode.com/posts/1", data, {headers})
.then( res => console.log(res))
.catch( err => console.log(err));

DELETE request with headers and data:

const headers = {
    'Content-type': 'application/json; charset=UTF-8',
};

const data = {
    title: 'foo',
    body: 'bar',
    userId: 1,
};

restHelper.delete("https://jsonplaceholder.typicode.com/posts/1", {headers, data})
.then( res => console.log(res))
.catch( err => console.log(err));

PATCH request with data:

const data = {
    title: 'foo',
    body: 'bar',
    userId: 1,
};

restHelper.patch("https://jsonplaceholder.typicode.com/posts/1", data)
.then( res => console.log(res))
.catch( err => console.log(err));

📘 API Documentation

`get(url, [config])`

Sends a GET request to the specified URL.

Parameters:

url (string): The URL to which the request is sent.
config (object, optional): Configuration options for the request.

Config Options

headers (object): Headers to be added to the request.
params (object): URL parameters to be sent with the request.
timeout (number): Specifies the number of milliseconds before the request times out.
withCredentials (boolean): Indicates whether or not cross-site Access-Control requests should be made using credentials.

Returns: Promise - A Promise that resolves to the response to the request.