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

koa-object-router

v1.11.2

Published

A router for koa that can optionally be loaded from the filesystem.

Downloads

134

Readme

koa-object-router

A router for koa that can optionally be loaded from the filesystem.

Setup

npm i koa-object-router

Usage

const Koa = require("koa");
const { router } = require("koa-object-router");

const app = new Koa();
app.use(
  router({
    /* config */
  })
);

Config

At least routesDirectory or routers should be specified.

interface RouterConfig {
  // Absolute path to a directory where route files are located
  routesDirectory?: string;
  // Object containting routers and routes
  routers?: Record<string, { options?: RouterOptions; routes: RouterRoutes }>;
  // If no route is specified, pass control to the next piece of koa middleware (default false)
  passThrough?: boolean;
  // Prefixes all routes with the specified string
  prefix?: string;
  // Exclude router files that match the specified regex
  excludeRegexString?: string;
  // Specifies which router is used as the index (defaults to "index")
  index?: string;
  // A function to be called any time a non 4xx HTTP error is thrown from a route
  errorHandler?: (error: unknown) => void;
}

Router Options

These options can be associated with a router and applied to all routes within the router.

interface RouterOptions {
  // Middleware to be run before each route in the router
  middleware?: MiddlewareHandler[];
  // Prefixes all routes within the router with the specified string
  prefix?: string;
  // A number dictating the priority of this router if it has conflicting routes with another router. Lower routers have higher priority.
  priority?: number;
}

Examples

Load routes from an object.

server.js

const Koa = require("koa");
const { resolve } = require("path");
const { router } = require("koa-object-router");

const app = new Koa();
app.use(bodyParser());
app.use(
  router({
    routers: {
      index: {
        routes: { "GET /": () => "results from your index route" },
      },
      users: {
        routes: {
          "GET /": async () => {
            return [
              // users
            ];
          },
          "POST /": async (ctx) => {
            const user = await User.create(ctx.body);
            return user;
          },
        },
      },
    },
  })
);
app.listen(3000);

Load routes from the filesystem.

In this example the filesystem should look something like the tree below.

.
└── src/
    ├── server.js
    └── routes/
        ├── index.js
        └── users.js

server.js

const Koa = require("koa");
const { resolve } = require("path");
const { router } = require("koa-object-router");

const app = new Koa();
app.use(bodyParser());
app.use(
  router({
    routesDirectory: resolve(__dirname, "routes"),
  })
);
app.listen(3000);

routes/index.js

exports.routes = {
  "GET /": () => "results from your index route",
};

Options