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-with-decorators

v2.0.1

Published

Koa-with-decorators supports basic injections. Controller can inject services/providers. Providers can have their own providers and so on... Your controller can have a constructor like in example below. ```javascript constructor(private readonly userS

Downloads

15

Readme

Super light-weight package with decorators, middleware support, interceptors and dependency injections

Koa-with-decorators supports basic injections. Controller can inject services/providers. Providers can have their own providers and so on... Your controller can have a constructor like in example below.

constructor(private readonly userService: UserService) { }

Type of provider must be specified with Class. You can't use interface here.

Example:
import Koa = require('koa');
import KoaRouter = require('koa-router');
import {Router as KoaRoutes, Middleware, Controller, Method, Interceptor, CustomInterceptor} from 'koa-with-decorators';

const PORT = process.env.PORT || 3000;
const root = new KoaRouter();
const app = new Koa();
const routes = new KoaRoutes();
 
 
class UserService {
    public users = ['First', 'Second', 'Third'];
}


class CInterceptor implements CustomInterceptor {
    constructor(private readonly userService: UserService) {}
    
    before(ctx: Koa.Context, next:Function) {
        /* Example of interceptor can be cache logic
        const cache = checkIfInCache();
        if(cache) 
            return ctx.body = cache;
        return next();
        */
        next(); // Before acts like middleware but runs after middleware decorator 
    }

    after(ctx: Koa.Context) { //Doesn't act like middleware, acts like method that runs after controller method. !You don't need to run next in your controller method!
        /*
            cache(something);
        */
        console.log(this.userService.users);
    }

    /* Note:
        You could also use this approach.
        Don't forget to use old js functions instead of arrow functions to get access to this
        This method is more complex but is better if you don't need any provider.
    
    intercept() {
        return {
            before: function(this: any, ctx: Koa.Context, next:Function) {
                console.log(this.userService.users);
                console.log('Ran before');
                next()
            },
            after: (ctx: Koa.Context) => {
                console.log('Ran after');
            }
        }
    }
    */
}
 
@Controller('users')
class UsersRoutes {
    constructor(private readonly userService: UserService) {}
 
    //If you don't care about providers and you don't need them in your middlewares
     //If you don't care about providers and you don't need them in your middlewares
     @Middleware([
        (ctx: Koa.Context, next:any) => {next()}, 
        (ctx: Koa.Context, next:any) => {next()}
    ])
    @Interceptor(CInterceptor)
    @Method('GET', '/usersB')
    getUsers(ctx: Koa.Context) {
        ctx.body = this.userService.users;
    }
    //If you want to have this context (to access providers for example) in your middlewares you can do this
    @Interceptor(CInterceptor)
    @Method('GET', '/usersA', true)
    _getUsers(){
        return [ //You have access to this
            (ctx: Koa.Context, next:any) => {console.log('I got users '+this.userService.users); next();},
            (ctx: Koa.Context, next:any) => {console.log('Second middleware'); next()},
            (ctx: Koa.Context) => { ctx.body = this.userService.users}
        ]
    }
}
 
root.use('/api', routes.registerRoutes(UsersRoutes, true).routes());
 
app.use(root.routes());
app.use(root.allowedMethods());
 
app.listen(PORT, () => console.log('Listening to port '+PORT));