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

simple-http-request-builder

v2.0.1

Published

A simple HTTP request interface written in TypeScript

Downloads

869

Readme

Simple HTTP Request Builder

This library provides:

  • A very basic representation of an HTTP request that is independent of any HTTP client
  • A fluent API to create an HTTP request and make an HTTP call (though to execute the call, an HTTP client must be provided)

Installation

Using NPM:

npm install simple-http-request-builder

Using Yarn:

yarn add simple-http-request-builder

Usage

An HTTP client is something that takes an HTTP request as a parameter and returns something. It can be a Promise, an Object or whatever.

Usage example using an HTTP client:

const response: Promise<Response> = new HttpRequest<Promise<Response>>(
  httpClient,
  'http://localhost/api',
  HttpMethod.GET,
  '/session',
)
.queryParams([['username', 'test'], ['password', 'azerty']])
.execute();

The HttpRequest creation process should generally be made using a dedicated class. Examples can be found:

In a browser environment, the base URL can be built using the window.location object: ${window.location.protocol}//${window.location.host}/api

HTTP Client sample using fetch

This sample is from Simple HTTP REST Client library.

const httpClient = (httpRequest: HttpRequest<unknown>): Promise<Response> => {
  const timeoutHandle = setTimeout(
    () => httpRequest.optionValues.timeoutAbortController.abort(),
    httpRequest.optionValues.timeoutInMillis,
  );
  return fetch(
    httpRequest.buildUrl(),
    {
      headers: httpRequest.headersValue,
      method: httpRequest.method,
      body: httpRequest.bodyValue,
      credentials: httpRequest.credentials,
      signal: httpRequest.optionValues.timeoutAbortController.signal,
    },
  )
  .finally(() => clearTimeout(timeoutHandle));
};

Timeout

By default, the request global timeout is 20 seconds (connect + wait + read). This can be configured using the request options method:

const response: Promise<Response> = new HttpRequest<...>(...)
  .queryParams(...)
  // 60 seconds timeout
  .options({ timeoutInMillis: 60000 })
  .execute();

Request cancellation

To cancel the request manually, it is also possible to specify the AbortController as an option:

const abortController = new AbortController();
const response: Promise<Response> = new HttpRequest<...>(...)
  .queryParams(...)
  // 60 seconds timeout
  .options({ timeoutAbortController: abortController })
  .execute();

// then later, the promise can be manually stopped if it hasn't been resolved
abortController.abort(); // the promise is now cancelled