npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@everymundo/http-client

v4.6.0

Published

This is a helper to perform POST requests using promises and no external dependencies

Downloads

199

Readme

http-client

Coverage Status Node.js CI Maintenance CodeQL

This is yet another nodejs async/promise based /https?/ client.

Features

  • Automatically retries to send the requests when statusCode > 399
  • Supports sending compressed data
  • Supports readging compressed data

Install

npm install @everymundo/http-client

Usage

POST some data

const httpClient = require('@everymundo/http-client')

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

const res = await endpoint.post(endpoint, data)

Alternatively you can do this:

POST some data

const httpClient = require('@everymundo/http-client')

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)
// OR
const res = await httpClient.promisePost(endpoint, data)
// OR
const res = await httpClient.post(endpoint, data)

Write methods

If you want to use PUT, PATCH or DELETE, just pass the method name on the options object, don't forget to use .Endpoint when creating the endpoint object

const httpClient = require('@everymundo/http-client')

const headers = { 'content-type': 'application/json' }
// Note that httpClient.Endpoint is used instead of .PostEndpoint
const endpoint = new httpClient.Endpoint('http://your-host.com/path', headers)
// Here we set the write method desired
const options = { method: 'PUT'}
const data = { myData:'Something' }
const res = await httpClient.promiseDataTo(endpoint, data, options)
// OR
const res = await httpClient.promisePost(endpoint, data, options)
// OR
const res = await httpClient.post(endpoint, data, options)

POST compressed data

const httpClient = require('@everymundo/http-client')

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

// because of the x-compression header this will be gzipped after JSON.stringify
const res = await httpClient.post(endpoint, data)

GET some data

const httpClient = require('@everymundo/http-client')

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

const res = await httpClient.promiseGet(endpoint)
// OR
const res = await httpClient.get(endpoint)

POST using the Fetch API

const httpClient = require('@everymundo/http-client')

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

HEAD request

const httpClient = require('@everymundo/http-client')

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

GET using the Fetch API

const { fetch } = require('@everymundo/http-client')

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

HEAD using the Fetch API

const { fetch } = require('@everymundo/http-client')

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]
    err,
    method, // Request Method
    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, // uncompressed responseBuffer if that one is compressed, otherwise, responseBuffer
    responseBuffer, // 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
}