Code Monkey home page Code Monkey logo

koa-r's Introduction

koa-r

Requesting node modules from some proxy object;

Installation

npm install koa-r

Example

var r = require('koa-r').isGlobal(true);
r.set('someModule', require('path/to/someModule'));
// etc...

// and then when you need to call some function from loaded module
r('someModule', 'someFn')();

As you can see we need to specify key and value for some module, and after that we can access to loaded module from some other place. Note that if isGlobal option is setted to true, we don't need to require koa-r twice. We need to require it only once, and after that it will in GLOBAL.r variable.

I am using this module in combination with koa-router. My idea is to separate routes definitions into multiple files, and then from one central place to mount routes to some url paths. Before that we set to koa-r all required dependencies for executing route callbacks, so we can call easily functions which are handling some routes. Example:

// some/path/handlers/user.js
exports.getUsers = function * (next) {
  // some code here...
  yield next;
}
// some/path/router/index.js
var mount = require('koa-mount'),
  r = require('koa-r').isGlobal(true),
  userAPI = require('some/path/router/user.js');

r.set('user', require('/some/path/handlers/user'));
// etc...

module.exports = function (app) {
  app.use(mount('/api/user/', userAPI.middleware()));
  // etc...
};
// some/path/router/user.js
var Router = require('koa-router'),
  api = new Router();

api.get('/users', r('user', 'getUsers'));
module.exports = api;

When user visits api/user/users url, function getUsers from user module will handle this route.

License

MIT

koa-r's People

Contributors

ivpusic avatar

Stargazers

Charlike Mike Reagent avatar  avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.