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

annotation-router

v0.8.0

Published

Bring annotations to your everyday routing framework

Downloads

2

Readme

node-annotation-router Build Status Coverage Status

Bring annotations to your favorite routing framework

Install

$ npm install --save annotation-router

Usage

given this file controller.js

/*
    @routePrefix('/api')
*/
module.exports = {

    // @httpGet()
    // @route('/collection')
    collection: function(){

    },


    // @route('/collection/{id}')
    getIndex: function(){

    },

    // @route('/collection')
    postItem: function(){

    },
> };

You can then simply retrieve each single route by doing so:


var annotationRouter = require('annotation-router');

annotationRouter('controller.js', function(err, route){

    console.log(route);
    /*
        {
            url: '/api/collection',
            method: 'GET',
            action: /* the action function */
        },
        ...
    */
}, function(err){
    // all routes have been parsed
});

API

annotationRouter(paths, eachCallback, finalCallback);

paths

Required
Type: string, array

paths of the all the controllers in the solution that will be checked for routing annotations
check globby for details

eachCallback(err, route)

route.url

Type: string

route.method

Type: string
Possible Values: GET, POST, PUT, DELETE, HEAD

route.action

Type: Function

The action function associated with the route

finalCallback(err)

Annotations API

@routePrefix(url)

All the functions inside the module will prepend the prefixUrl to theirs urls

@route(url)

The function following this annotation will be called when someone request the url

@httpGet() and equivalents

Set the method of the route
If none of the available method definition annotation could be found, the route's method will be guessed from the name of the function

Inspiration

Vatican is another library which use annotation to define routes. Although it's a standalone library which means you can't use your favorite routing library.

If you ever work with Microsoft's MVC library, you surely noticed that we are trying to reproduce the same behavior.

Licence

MIT © Thomas Sileghem