caju-request v1.1.0

Caju Request

Promise based HTTP client for the browser and node.js

About

This lib was created to centralize the pattern of requests, being possible in future axios migrations, just change the version of this lib here.

Installation

$ npm install caju-request

Request Config

These are the available config options for making requests. Only the url is required. Requests will default to GET if method is not specified.

{
  // `method` is the response that was provided by the server
  method: 'post',
  // `url` is the server URL that will be used for the request
  url: 'https://caju.com.br/api',
  // `mock` is a flag for fetching mock files (under development)
  mock: false, //boolean
  // `headers` are custom headers to be sent
  headers: {},
  // `data` is the data to be sent as the request body
  data: {},
  // `timeout` specifies the number of milliseconds before the request times out.
  // If the request takes longer than `timeout`, the request will be aborted.
  timeout: 1000, // default is `0` (no timeout)
}

Response Schema

The response for a request contains the following information.

{
  // `status` is the HTTP status code from the server response
  status: 200,
  // `message` is the response that was provided by the server
  message: 'Data processed successfully',
}

• Performing a POST request

const cajuRequest = require('caju-request');

cajuRequest({
  method: 'post',
  url: 'https://caju.com.br/api/user',
  mock: false,
  headers: {
    'Content-Type': 'application/json'
  },
  data: {
    email: 'example@caju.com.br',
    name: 'Example name'
  }
})
.then((response) => {
    console.log(response);
})
.catch((error) => {
  console.log(error);
});

• Performing a GET request

const cajuRequest = require('caju-request');

cajuRequest({
  method: 'get',
  url: 'https://caju.com.br/api/users',
  mock: false
})
.then((response) => {
  console.log(response);
})
.catch((error) => {
  console.log(error);
});