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

@eryue/koa-router-mapping

v1.1.10

Published

a way to make your koa router Configurable & Combinable & Reusable, yeah, just a function mapping.

Downloads

4

Readme

a way to make your koa router Configurable & Combinable & Reusable, yeah, just a function mapping.

Usage


this has a koa-router dependency, so, you no longer need to import it. now, you can have a think, every route path as a key and can be splited by /, that would look like a nested object, and at last it's value just a function.

  • Install
npm i @eryue/koa-router-mapping
// or
yarn add @eryue/koa-router-mapping
  • Hello, world!
import Koa from 'koa';
import RouterMapping from '@eryue/koa-router-mapping';

const app = new Koa();
const router = new RouterMapping();

router.get(/* prefix */{
  'api/greet': 'Hello, world !'  // same as `cx => cx.body = 'Hello, world !'`
  //...
});

app.use(router.mapRoutes());
app.listen(1234);

curl localhost:1234/api/greet will response Hello, world !;

  • More

this example is too simple, but that not all.

import RouterMapping from '@eryue/koa-router-mapping';

const router = new RouterMapping();

async function getUserList(cx, next) {
  const userList = await cx.service.getUserList();
  cx.body = userList;
} 
async function getUserInfo(cx, next) {
  const userInfo = await cx.service.getUserInfo(id);
  cx.body = userInfo;
}

router
.prefix('api')
.get({
  user: {
    list: getUserList,
    'info/:id': getUserInfo
  },
  order: {
    list: [getUserInfo, getOrderList],
    'detail/:id': [getUserInfo, getOrderDetail]
  }
});

/* 4 router.
'/api/user/list',
'/api/user/info/:id',
'/api/order/list',
'/api/order/detail/:id'
*/

app.use(router.mapRoutes());

this just a GET method, others[post/put/patch/del/delete/all] has a same way to use, as you can see, a nested object and some functions make our router Configurable & Combinable & Reusable.

  • option

  • prefix: String

same to router.prefix()

  • maxLevel: Number

due to there is a nested object, set maxLevel to prevent too many api level.

  • rebindHandles: Function(handles)

use it carefully, it callback every router's handles, just a function or array of function, so, you can rebind every function or inject some params you want.

if you want to experience the magic of rebindHandles, let's move way to @eryue/core