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

router-decorator

v0.1.0

Published

Simple router ES7 decorators

Downloads

2

Readme

node-router-decorator

Simple router ES7 decorators for Node.js.

This library implemented on top of the ES7 decorators proposal. Which can only be used with transpilers such as Babel.

Installation

npm install --save router-decorator

Usage

Use in Node.js

import http from 'http';
import {router, route} from 'router-decorator';

function setHeaders(req, res, next) {
  res.statusCode = 200;
  res.setHeader('Content-Type', 'text/plain');
  next();
}

@router
class MyApp {
  @route('/', setHeaders)
  index(req, res) {
    res.end('Hello World\n');
  }

  @route('/users/:userId', setHeaders)
  user(req, res) {
    res.end(`Hello ${req.params.userId}\n`);
  }

  @route(/^\/posts\/(\d+)/, setHeaders)
  post(req, res) {
    res.end(`Hello ${req.params[1]}\n`);
  }
}

http.createServer(new MyApp()).listen(3000, () => {
  console.log('Example app listening on port 3000');
});

Use with Express

import express from 'express';
import {router, route} from 'router-decorator';

const app = express();

@router
class MyApp {
  @route('/')
  index(req, res) {
    res.send('Hello World\n');
  }

  @route('/users/:userId')
  user(req, res) {
    res.send(`Hello ${req.params.userId}\n`);
  }

  @route(/^\/posts\/(\d+)/)
  post(req, res) {
    res.send(`Hello ${req.params[1]}\n`);
  }
}

app.use(new MyApp('hello'));

app.listen(3000, () => {
  console.log('Example app listening on port 3000');
});

API

@router(options = {})

Class that is marked with this decorator is constructed as router middleware and its annotated methods are registered as routes.

options

| Name | Description | Default | | ---- | ----------- | ------- | | methods | Allowed HTTP methods. | ['GET', 'POST', 'PUT', 'DELETE'] |

@route(matcher, method = 'GET', ...middleware)

Methods marked with this decorator will register a request made with given method HTTP method to a path that matches the given matcher.

matcher

type: string|RegExp|function

Path matcher for the route; can be any of:

  • A string representing a path.
  • A path with named parameter.
  • A regular expression pattern to match paths.
  • A function that returns an array or null taking an argument of path.
Path matcher examples

The following table provides some simple examples of valid path matcher value.

| Type | Example | Description | | ---- | ------- | ----------- | | Path | @route('/abcd') | This will match paths starting with /abcd. | | Named parameter | @route('/abcd/:id') | This will match paths starting with /abcd, and set a value of the path segment located at the :id to req.params. | | Regular expression | @route(/\/abc|\/xyz/) | This will match paths starting with /abc and /xyz. | | Function | @route((path) => path.startWith('efg')) | This will match paths starting with /efg. |

method

type: string

HTTP method for the route. If the asterisk is specified, applies to the all methods that are allowed by the router methods option.

middleware

type: function

Express-style middleware for the route.

License

MIT