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

@curveball/static

v1.0.0

Published

A curveball middleware for serving static files from a filesystem

Downloads

1,211

Readme

Curveball Static File Middleware

This package is a middleware for Curveball. It serves static files from a directory.

Installation

npm install @curveball/static

Getting started

import { Application } from '@curveball/kernel';
import serveFiles from '@curveball/static';
import { join } from 'path';

const app = new Application();
app.use(
    serveFiles({
        // Absolute path to assets directory
        staticDir: join(__dirname, 'assets'),
    })
);

Serving files from a different directory

It is possible to serve files from a directory that doesn't math your request path.

For example: | Static Dir | Request URI | |---------------------|-------------------| | /home/app/static | /assets/app.css |

You would configure it like this:

import { Application } from '@curveball/kernel';
import serveFiles from '@curveball/static';
import { join } from 'path';

const app = new Application();
app.use(
    serveFiles({
        // Absolute path to assets directory
        staticDir: join(__dirname, 'static'),
        pathPrefix: '/assets',
    })
);

API

The default export for this package is the serveFiles function. When called, this function returns a middleware. It accepts a dictionary of configuration options.

Options

  • staticDir: Absolute path to assets directory. Assets cannot be served above this directory.
  • pathPrefix: Request path to match if it differs from the static directory.
  • maxAge: If specified, this will cause a Cache-Control: max-age=n header to be added, where n is the value of maxAge.