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

node-file-router

v0.6.0

Published

A powerful file-based routing for Express.js, Bun, pure Node.js and more

Downloads

570

Readme

Node File Router

product of the week

Codacy Badge ci Status npm downloads license

A powerful file-based routing for Node.js.

It simplifies the creation and organization of API services. You can effortlessly map your project's file structure to your API endpoints, enabling a clear and maintainable codebase.

  • Technology Agnostic:
    • Express
    • Pure Node HTTP
    • Bun
    • Sockets
    • ... whatever compatible with the interface
  • 0 dependencies
  • CommonJS and ES modules support
  • TypeScript support
  • 100% test coverage
  • Middlewares support

Overview

Imagine you have a project with the following structure:

api/
├── profile/
│   ├── middlware.ts - middleware for profile
│   └── orders.[post].ts - methods in any filenames
├── catalog/
│   └── [[...tags]].ts - several segments
├── collection/
│   └── [cid]/ - slugs in folders
│       └── products/
│           └── [pid].ts - slugs in files
├── index.ts - root
├── middleware.ts - middleware for all routes
└── _404.ts - not found response    

Node File Router will automatically map it to your API endpoints:

  • [POST]: /profile/orders → /api/profile/orders.[post].ts
  • /catalog/men/black/denim → /api/catalog/[[...tags]].ts
  • /collection/77/products/13 → /api/collection/[cid]/products/[pid].ts
  • / → index.ts

Some examples of how your file handlers can be written:

Methods in a file

export default {
  get(req, res, routeParams) {},
  post(req, res, routeParams) {},
  patch(req, res, routeParams) {},
}

Single response function

export default function (req, res, routeParams) {}

Middlewares chain

export default [
  useErrorHandler,
  useLogger,
  useAuthGuard,
];

Documentation

npm i node-file-router

Visit website to get started and view the full documentation.

Usage:

Methods routing:

Route matching:

Support other protocols and frameworks:

Middlewares:

Examples

Visit examples folder to see samples with different module systems, adapters, and use cases.

Support

I usually respond within 24 hours. Fixes typically take 1-3 days. Additionally, I provide time estimations for new features and fixes. Feel free to ask questions, voice ideas, and share your projects on Github Discussion.

Developing

To begin development and contribution, read this guide.