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

fs-serve

v4.3.0

Published

Serve static files with HTTP

Downloads

46

Readme

Serve static files with HTTP

Serve static files with:

  • configurable directory listing
  • a wide range of pre-configured mime-types
  • charset utf-8 for text file types
  • configurable caching (including etags and custom max-age)
  • streamed responses

Usage (CLI)

Serve the content of this directory. Directory listing are enabled:

npm install -g fs-serve
fs-serve

Serve the content of the wwww on port 3333 to localhost:

fs-serve path www port 3333

Usage (JS)

npm install fs-serve

Note that only ES module imports are supported (not require)

import Server from "fs-serve";

let httpServer = await new Server("www").listen(3000);
console.log(await (await fetch("http://localhost:3000/")).text());
httpServer.close();

API

import Server from "fs-serve";

let directory = "www";
// Create a new server
const server = new Server(directory, {
  directoryList: false,
  log: (url, statusCode, result) => console.log(url, statusCode, result),
  maxAge: 2,
  ssi: {
    extension: ".shtml",
    handlers: [Server.includeVirtual]
  }
});
  • directoryList - set to true to enable directory lists - default false
  • log - provide a callback for custom logging, or set to falsy to disable logging - default console.log
  • maxAge - how many seconds a client should cache a response - default 2 seconds
  • ssi - a list of extensions with SSI handlers

Serve a request in an existing web server:

import Server from "fs-serve";
import http from "http";

const server = new Server("www");

http.createServer((req, res) => server.serve(request, response));

Create an http server and listen on port and host:

import Server from "fs-serve";

let port = 4444;
let host = "localhost";
let httpServer = await new Server("www").listen(port, host);
httpServer.close();

The port will be selected automatically if omitted, and the server will listen on all addresses if the host is omitted. See https://nodejs.org/api/net.html#serverlisten for details.