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

hurp-http-server

v1.0.4

Published

Hurp module wrapper for Node.js http[s].Server

Downloads

34

Readme

hurp-http-server

npm

Async module wrapper for native Node.js http.Server with graceful shutdown.

More about Hurp and how to use it:
https://github.com/yaroslav-korotaev/hurp

Installation

$ npm install hurp-http-server

Usage

In a Hurp-Based Application

import Hurp from 'hurp';
import HttpServer from 'hurp-http-server';
import { Log } from 'hurp-types';

export interface Options {
  log: Log;
}

export default class App extends Hurp {
  public readonly server: HttpServer;
  
  constructor(options: Options) {
    super();
    
    const server = new HttpServer({
      log: options.log,
      handler: (req, res) => res.end('hello, world'),
      listen: {
        host: 'localhost',
        port: 3000,
      },
    });
    this.server = this.use(server);
  }
}

Standalone

import pino from 'pino';
import HttpServer from 'hurp-http-server';

async function main() {
  const log = pino();
  
  const server = new HttpServer({
    log,
    handler: (req, res) => res.end('hello, world'),
    listen: {
      host: 'localhost',
      port: 3000,
    },
  });
  
  // Start listening
  await server.init();
  
  // Shutdown gracefully
  // await server.destroy();
}

Logger

Logger instance must be compatible with that interface:

interface Log {
  child(bindings: { [key: string]: any }): Log;
  info(message: string): void;
}

This approach is inspired by Bunyan. You can use a compatible logger like pino directly or write a simple wrapper around any other you like.

Types

Options

import { Options } from 'hurp-http-server';

An object, HttpServer constructor options.

tag?: string

Will be used as module tag and passed as tag field in bindings to child logger. Optional, value http-server used by default.

log: Log

Base logger used to create child logger for new HttpServer instance.

server?: http.Server

Optional native Node.js http server instance. If undefined, a new one will be created by default.

handler: (req: http.IncomingMessage, res: http.ServerResponse) => void

Request handler, will be attached to wrapped native http server instance as request event listener.

listen?: net.ListenOptions

Options will be passed to listen() method of http server instance.

API

HttpServer

import HttpServer from 'hurp-http-server';

A class, async module wrapper for native Node.js http server.

constructor(options: Options)

Creates a new HttpServer instance.

options: Options - instance options

async init(): Promise<void>

Initializes the http server by opening a port. Will throw an error in a case with error event from underlying native http server instance.

async destroy(): Promise<void>

Closes listening port and waits for pending requests. All keep-alived connections with no pending requsts will be closed immediately.