@everymundo/promise-data-to

3.0.3 • Public • Published

promise-data-to

This is a helper to perform POST requests using promises.

Install

npm install @everymundo/promise-data-to

Usage

POST some data

const httpClient = require('@everymundo/promise-data-to')

const headers = { 'content-type': 'application/json' }
const endpoint = new httpClient.PostEndpoint('http://your-host.com/path', headers)
const data = { myData:'Something' }

const res = await httpClient.promiseDataTo(endpoint, data)

GET some data

const httpClient = require('@everymundo/promise-data-to')

const headers = { 'authorization': 'your token' }
const endpoint = new httpClient.GetEndpoint('http://your-host.com/path', headers)

const res = await httpClient.promiseGet(endpoint)

POST using the Fetch API

const httpClient = require('@everymundo/promise-data-to')

const headers = { 'authorization': 'your token' }
const res = await httpClient.fetch('http://your-host.com/path', { headers, body: data })

GET using the Fetch API

const { fetch } = require('@everymundo/promise-data-to')

const headers = { 'authorization': 'your token' }
const res = await fetch('http://your-host.com/path', { headers })

Response Schema

{
    statusCode, // the response statusCode
    code, // alias for statusCode [for backaward compatibility]
    start, // Date Object captured right before starting the request
    end: Date.now(), // Int Timestamp from when the request has finished
    attempt, // the number of attempts of the retries
    endpoint, // the endpoint object either passed or generated from a string
    resTxt, // alias for responseText [for backaward compatibility]
    responseText, // the response buffer.toString()
    buffer, // raw response buffer
    dataType, // the name of the constructor of the posted data [Array, Object, String, Buffer]
    dataLen, // when posting arrays it shows the number of array items posted
    compress, // the type of compression for the POST request, if any. Valid values are gzip and deflate
    requestHeaders, // the headers used on the request
    responseHeaders // the headers received from the remote server
}

Some Features

  • Automatically retries to send the requests when statusCode > 399

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 3.0.3
    1
    • latest

Version History

Package Sidebar

Install

npm i @everymundo/promise-data-to

Weekly Downloads

3

Version

3.0.3

License

MIT

Unpacked Size

24.1 kB

Total Files

21

Last publish

Collaborators

  • a11y-dev
  • jsalvadorpp
  • lindolo25
  • double2-us
  • ceciliagalarza
  • carla-villegas
  • eblez
  • mjremedios1985
  • mtmorell88
  • a11y_automation2
  • ramses83
  • raydel
  • alex-orga
  • estebanpablo89
  • yartiles
  • jonmorazav
  • everymundo-admin
  • ballester
  • danielsan
  • halain
  • avivero93
  • anahiem
  • herlin
  • karinfdez
  • erlin
  • front10devs
  • hdelcastillo
  • dcuevacem
  • rodneyem
  • ortega.dc98
  • pedroleon917
  • kaylingw
  • lazjramos
  • daniuska-em