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

@dobschal/express-route-loader

v1.0.1

Published

Automaticaly load route handlers from script files, catch errors and map the function name to the URL path.

Downloads

6

Readme

Express Auto Loader

Automaticaly load route handlers from script files, catch errors and map the function name to the URL path.

function getArticles() {} // becomes HTTP GET /articles 🙌

Get Started

Installation

# Install the package via NPM:
npm install --save @dobschal/express-route-loader

Import

// CommonJS
const { routeLoader } = require("@dobschal/express-route-loader");
// ESM
import { routeLoader } from "@dobschal/express-route-loader";
// TypeScript
import { routeLoader } from "@dobschal/express-route-loader/src/index";

Use

// Expect to have all route handlers in routes/
app.use(routeLoader(path.join(__dirname, "routes")));

Router Handler

// Will add GET /users route handler
export function getUsers() {
    // ...
    return users;
}

Example

// src/app.js

// Import dependencies
// via require...
const express = require('express');
const path = require('path');
const { routeLoader } = require("@dobschal/express-route-loader");
// ...or via import
import { routeLoader } from '@dobschal/express-route-loader';
import express from 'express';
import path from 'path';

// Instantiate express app and configure...
const app = express();

// Apply auto loader
app.use(routeLoader(path.join(__dirname, "routes")));

app.listen(/* ... */);
// src/routes/user.js

// This will apply as route handler for GET /users

// Via CommonJS...
module.exports.getUsers = async function(body, req, res) {
    const users = await loadUsers();
    res.send({ users });
}
// or ESM
export async function getUsers(body, req, res) {
    const users = await loadUsers();
    res.send({ users });
}

TypeScript Support

TypeScript build via tsc works, but via ts-node not. To make TypeScript working in dev mode, you need to copy the src/index.ts file into your project and import routeLoader from there.

Add the copy command to the postinstall script in your package.json:

{
  "scripts": {
    "start": "...",
    "postinstall": "rm -rf lib/dobschal && mkdir -p lib && mkdir -p lib/dobschal && cp node_modules/@dobschal/express-route-loader/src/index.ts lib/dobschal/route-loader.ts\n"
  }
}

Then import like so:

import { routerLoader } from "../lib/dobschal/route-loader.ts";

Auto Response

Instead of calling res.send(/* ... */) you can use the return keyword.

export async function getUsers() {
    return { users: await loadUsers() };
}

Error Handling

If an error is thrown inside a route handler, the error is automatically forwarded to the Express Error Handler via the NextFunction.

export function postLogin({ password }) {
    
    // This will automatically be caught 
    // Just implement a global ExpressJS Error Handler 
    if(passwordIsWrong(password)) {
        throw new Error("Password is wrong.");
    }
}