@everymundo/promise-data-to - npm Package Compare versions

Comparing version 2.0.1 to 2.0.2

lib/promise-data-to.js

		@@ -87,2 +87,3 @@ 'use strict'
		const stats = {
		get statusCode () { return this.code },
		code: res.statusCode,
		@@ -95,2 +96,3 @@ start,
		resTxt,
		get responseText () { return this.resTxt },
		buffer,
		@@ -97,0 +99,0 @@ dataType: xData && xData.constructor.name,

package.json

		{
		"name": "@everymundo/promise-data-to",
		"version": "2.0.1",
		"version": "2.0.2",
		"description": "This is a helper to perform POST requests using promises and no external dependencies",
		@@ -5,0 +5,0 @@ "main": "index.js",

README.md

		@@ -8,1 +8,62 @@ # promise-data-to
		```

		## Usage
		### POST some data
		```js
		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
		```js
		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
		```js
		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
		```js
		const { fetch } = require('@everymundo/promise-data-to')

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

		## Response Schema
		```js
		{
		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

@everymundo/promise-data-to - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics