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

@haul/http-client

v0.2.1

Published

custom api on top of request promise native

Downloads

4

Readme

@haul/http-client ·

An abstraction on top of request-native-promise that makes functional composition easy.

Install

Using npm:

> npm install @haul/http-client

Using yarn:

> yarn add @haul/http-client

Usage

import { createClient, base, headers } from '@haul/http-client';

// Initialize a http client
const googleClient = createClient(
  // Set the baseurl to https://johndoe.com
  base('https://johndoe.com'),
  // Set user agent header
  headers({ 'User-Agent': 'robot' }),
);

;(async async () =>  {
  await googleClient('/some-page');

  // You can also pass a request config specific for one request
  await googleClient('/another-page', {
    method: 'POST',
    headers: { 'User-Agent': 'Not a robot' },
    body: {
      foo: 'bar'
    }
  })
})();

base(string)

Configures base url for the client.

headers({ key: value })

Configure header(s) for the client.

query({ key: value })

Configure query string for the client.

Extending

The http-client relies heavily on middleware so the easiest way to extend behaviour is the create your own.

import { createClient, RequestConfig } from '@haul/http-client';

interface CustomRequestConfig extends RequestConfig {
  myCustomProp: string;
}

export const myMiddleware = (myCustomProp: string) => (
  opts: RequestConfig
): CustomRequestConfig => {
  return {
    ...opts,
    myCustomProp: myCcustomProp,
  };
};

You can create more advanced middleware that is dependent on other values configured via other middleware:

export const myMiddleware = (myCustomProp: string) => (
  opts: RequestConfig
): CustomRequestConfig => {
  if (opts.headers && opts.headers['User-Agent'].toLowerCase() === 'robot') {
    opts.headers = {
      ...opts.headers,
      token: 'my robot token',
    }
  }
  return opts;
};

Note that middleware is called in the order they are passed to createClient. If you need to access a property defined from another middleware, your middleware must be called after.