3.0.2 • Published 12 months ago

@applitools/http-commons v3.0.2

Weekly downloads
40,006
License
Apache-2.0
Repository
github
Last release
12 months ago

http-commons

Library that has http common functionality, all around http-client currently.

Installing

npm install @applitools/http-commons

Using the package

Let's see an example with fetchAsJson

const {fetchAsJson} = require('@applitools/http-commons')

await fetchAsJson('https://swapi.co/api/people/1/') // ===> {name: "Luke Skywalker", ...}

API

All these functions with throw an exception if the status code is not 2xx. The excption will have the following properties:

  • code: it will be 'ERR_X_STATUS_CODE_NOT_OK'
  • status: the HTTP status code
  • statusText: the HTTP status text
  • headers: an object with the response headers

fetchAsBuffer(url, [fetchOptions], [options])

async fetches URL and returns a Buffer response.

url

The URL to fetch.

fetchOptions

The fetch options used by the node-fetch package.

options

The following options are available:

alternativeFetch

(For testing purposes) A function that will be used as an alternative to node-fetch-s fetch function.

returns

An object with the response body as JSON parsed.

Example

await fetchAsJson('https://swapi.co/api/people/1/') // ===> {name: "Luke Skywalker", ...}

fetchAsText(url, [fetchOptions], [options])

async fetches URL and returns the response as a string.

url

The URL to fetch.

fetchOptions

The fetch options used by the node-fetch package.

options

The following options are available:

alternativeFetch

(For testing purposes) A function that will be used as an alternative to node-fetch-s fetch function.

returns

A string with the response body.

Example

await fetchAsText('https://www.wikipedia.org')) // ===> "<!DOCTYPE html><html ..."

fetchAsTextWithJsonBody(url, json, [fetchOptions], [options])

async posts URL with a JSON body and returns the response as a string.

url

The URL to fetch.

fetchOptions

The fetch options used by the node-fetch package. Note that the default options are {method: 'POST', body: '_the_json_'}, with the correct content-type header, but you can override this using fetchOptions

options

The following options are available:

alternativeFetch

(For testing purposes) A function that will be used as an alternative to node-fetch-s fetch function.

returns

A string with the response body.

Example

await fetchAsTextWithJsonBody('https://httpbin.org/anything', {x: 4})) // ===> "{..{"x": 4}..}"

fetchAsJsonWithJsonBody(url, json, [fetchOptions], [options])

async posts URL with a JSON body and returns the response as a string.

url

The URL to fetch.

fetchOptions

The fetch options used by the node-fetch package. Note that the default options are {method: 'POST', body: '_the_json_'}, with the correct content-type header, but you can override this using fetchOptions

options

The following options are available:

alternativeFetch

(For testing purposes) A function that will be used as an alternative to node-fetch-s fetch function.

returns

A "JSON" object with the parsed body

Example

await fetchAsTextWithJsonBody('https://httpbin.org/anything', {x: 4}, {method: 'PUT'})) // ===> {..{"x": 4}..}

fetchAsBufferWithJsonBody(url, json, [fetchOptions], [options])

async posts URL with a JSON body and returns the response as a string.

url

The URL to fetch.

fetchOptions

The fetch options used by the node-fetch package. Note that the default options are {method: 'POST', body: '_the_json_'}, with the correct content-type header, but you can override this using fetchOptions

options

The following options are available:

alternativeFetch

(For testing purposes) A function that will be used as an alternative to node-fetch-s fetch function.

returns

A buffer with the response body.

Example

await fetchAsBufferWithJsonBody('https://httpbin.org/anything', {x: 4})) // ===> Buffer (....)

retryFetch(func, options)

Retries code and deals correctly with retrying HTTP and connection errors.

func

An async func that calls one of the fetch* functions above or the fetch in node-fetch directly.

options

retries

Number of retries before failing.

sleepTime

The time (in ms) for sleeping between retries

backoff

Exponential backoff factor for sleepTime

idempotent

Some errors, like 5xx http status error should not retry if the fetch operation is idempotent. So this flag says whether the operation is idempotent to know whether to retry.

returns

Whatever func returns

Example

const json = await retry(() => fetchAsJson('http://httpbin.org/anything'), {idempotent: true})
applitoolstestingbrowsergridvisual-testingnodejsjavascript
debugnode-fetchlodash.mergeagentkeepalive@applitools/functional-commons@applitools/monitoring-commons
@applitools/rendering-api-app@applitools/snapshot-server-app@applitools/query-splunk@infinitebrahmanuniverse/nolb-_appl@everything-registry/sub-chunk-76eg-operations-server@applitools/visual-grid-client@applitools/screenshot-stitching-client@applitools/visual-grid-cli-utils@applitools/eyes-scm
3.0.1-fixHttpAgent.1

1 year ago

3.0.2

12 months ago

3.0.0

2 years ago

2.4.7

3 years ago

2.4.5

4 years ago

2.4.3

6 years ago

2.4.1

6 years ago

2.3.12

6 years ago

2.3.10

6 years ago

1.3.9

6 years ago

1.3.7

6 years ago

1.3.5

6 years ago

1.3.3

7 years ago

1.3.1

7 years ago

1.2.9

7 years ago

1.2.7

7 years ago

1.2.5

7 years ago

1.2.3

7 years ago

1.2.2

7 years ago

1.2.1

7 years ago

1.1.1

7 years ago

1.0.23

7 years ago

1.0.22

7 years ago

1.0.20

7 years ago

1.0.19

7 years ago

1.0.18

8 years ago

1.0.17

8 years ago

1.0.16

8 years ago

1.0.15

8 years ago

1.0.14

8 years ago

1.0.13

8 years ago

1.0.12

8 years ago

1.0.11

8 years ago

1.0.10

8 years ago

1.0.9

8 years ago

1.0.8

8 years ago

1.0.7

8 years ago

1.0.6

8 years ago

1.0.5

8 years ago

1.0.4

8 years ago

1.0.3

8 years ago

1.0.2

8 years ago

1.0.1

8 years ago