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

express-automated-routes

v0.0.6

Published

This is an express middleware to create routes based on folder architecture

Downloads

8

Readme

https://travis-ci.org/wilmouths/express-automated-routes https://david-dm.org/wilmouths/express-automated-routes.svg Known Vulnerabilities Licence: MIT

express-automated-routes

express-automated-routes is an express middleware that allows you to create routes easily without declaring them.

You probably ask yourself the question of how the routes are made, the answer is simple, this middleware is based on the architecture of the folders.


Install

npm install express-automated-routes --save

Usage

const express = require('express');
const path = require('path');
const expressAutomatedRoutes = require('express-automated-routes');

const app = express();

app.set('middlewares', path.resolve(__dirname, 'middlewares')); // optional, default folder is ./middlewares
app.set('routes', path.resolve(__dirname, 'routes')); // optional, default folder is ./routes
expressAutomatedRoutes(app);

app.listen(8080, () => {
  console.log('Listening on http://localhost:8080');
});

How to add routes

To add roads, you need to create a roads folder at the root of your project, this middleware will be based on the architecture of this folder, e.g.

routes /
  - index.js
  - blog /
    - index.js
    - _id /
      - index.js
      - edit.js

The routes obtained are as follows :

/
/blog
/blog/:id
/blog/:id/edit

HTTP request methods are the usual ones

The HTTPS methods are the functions of the route file, e.g.

exports.get = (req, res) => {});
exports.post = (req, res) => {});
exports.patch = (req, res) => {});
exports.delete = (req, res) => {});
exports.update = (req, res) => {});
...

How to add middleware on route

To add a middleware to a route, you have to make a slight change in the function, which is as follows.

Your function will become an object with 2 elements, middlewares which is an array and handler which will be your route function. e.g.

exports.get = {
  middlewares: [
    (req, res, next) => {
      res.statusCode = 418;
      next();
    },
  ],
  handler: (req, res) => res.json({
    method: req.method,
    status: res.statusCode,
    data: 'I\'am a teapot !',
  }),
};

How to add global middleware

To add global middleware to the application you can use the express method :

app.use((err, req, res, next) => {
  res.status(err.status || 500);
  res.json(err);
});

Or you can create files in the middlewares folder and they will be loaded automatically. To define a middleware folder you have to proceed as follows :

app.set('middlewares', path.resolve(__dirname, 'middlewares'));

📝 License

This project is MIT licensed.