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

hrap

v2.3.1

Published

A native Promise wrapper for http(s).request

Downloads

85

Readme

HRaP - HTTP Requests as Promise

This Node.js module provides the event based request function from the http and https modules in Node's API in the Promise format, such that HTTP(S) requests may be programmed in a sequential order in your source code.

Features

  • Laissez-faire error handling: You provide the promise rejection handler
  • Depends on native Node modules only
  • Zero polyfilling
  • Encoding opinionated (there might be other HTTP libraries who fare better with use cases involving support for other kinds of string coding)
  • Following redirects: Just add followRedirects: true to the options parameter. Implemented with the 3rd party module follow-redirects

Exported functions

Importing the module when using CommonJS modules:

const hrap = require('hrap')

When using EcmaScript modules:

import hrap from 'hrap'

Consumption

const hrap = require('hrap')

const onResponse = ({ status, message, contentType, body }) => {
  console.log(contentType) // application/json; charset=utf-8
  console.log(status) // 200
  console.log(message) // OK
  const { userId, id, title, completed } = JSON.parse(body)
  console.log(userId) // 1
  console.log(id) // 1
  console.log(title) // 'delectus aut autem'
  console.log(completed) // false
}

const onError = ({ stack }) => {
  console.log(stack)
}

hrap('https://jsonplaceholder.typicode.com/todos/1').then(onResponse).catch(onError)

Function parameters

The default export accepts as argument two parameters: the former is the URL to the resource, either in its URL object format, or in conventional string form. The latter is the set of options passed to http.ClientRequest.request. As of version 2.1.0 you can also feed in just the request options object, which is assumed to include relevant URL parameters such as protocol, hostname and port. If you want to pass a request body to be written to the request, put as a full string on the body property in the options parameter.

The value passed to the resolver callback

The resolve function in the returned Promise instance will receive one argument, an object consisting of four properties:

  • the response body, body
  • the response status code, status
  • the response status message, message
  • the content type of the response, contentType

Whenever the error event is fired internally, the error object is passed on to the reject callback in its entirety.

Miscellaneous