{"id":15097911,"url":"https://github.com/capdilla/koa2-controller","last_synced_at":"2026-01-06T15:41:26.677Z","repository":{"id":106017679,"uuid":"126893221","full_name":"capdilla/koa2-controller","owner":"capdilla","description":"library to handle the routes and controller at same time","archived":false,"fork":false,"pushed_at":"2018-12-30T16:54:00.000Z","size":50,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T17:44:50.992Z","etag":null,"topics":["controller","koa","koa2","koajs","router"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/capdilla.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-26T21:39:25.000Z","updated_at":"2018-12-30T16:54:01.000Z","dependencies_parsed_at":"2023-06-18T04:33:23.339Z","dependency_job_id":null,"html_url":"https://github.com/capdilla/koa2-controller","commit_stats":{"total_commits":22,"total_committers":3,"mean_commits":7.333333333333333,"dds":0.2727272727272727,"last_synced_commit":"73736949bd136d01f1e1b182b96805dd788eefe7"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capdilla%2Fkoa2-controller","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capdilla%2Fkoa2-controller/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capdilla%2Fkoa2-controller/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capdilla%2Fkoa2-controller/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/capdilla","download_url":"https://codeload.github.com/capdilla/koa2-controller/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245854695,"owners_count":20683399,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["controller","koa","koa2","koajs","router"],"created_at":"2024-09-25T16:41:20.845Z","updated_at":"2026-01-06T15:41:26.651Z","avatar_url":"https://github.com/capdilla.png","language":"JavaScript","readme":"[![Build Status](https://travis-ci.org/capdilla/koa2-controller.svg?branch=master)](https://travis-ci.org/capdilla/koa2-controller)\n\n# koa2-controller\nlibrary to handle the routes and controller at same time\n\n## Installation\n```sh\nnpm i koa2-controller-router --save\n```\n\n**Example**  \nBasic usage:\n  `of koa2Controller`\n\n```javascript\nconst {koa2Controller} = require('koa2-controller-router')\n\nclass testController extends koa2Controller {\n\n  //if you need to set parameters \n  constructor(props) {\n    super(props)\n  }\n\n  paramsBehaviour() {\n    return {\n      postCreate: {\n        rules: [\n          { name: 'mail', type: 'require' },// say to require this\n          { name: 'password', type: 'require' },\n        ]\n      },\n    }\n  }\n\n  //create a http get\n  getHello(ctx, next) {\n    return ctx.body = \"Hello world\"\n  }\n\n  //create a http post\n  postCreate(ctx) {\n    return ctx.body = \"created\"\n  }\n\n  //create a http put\n  putUser(id, ctx) {\n    return ctx.body = `user id : ${id} , updated`\n  }\n\n  //create a http del\n  delUser(id, ctx) {\n    return ctx.body = `user id : ${id} , deleted`\n  }\n\n  /**\n   *  if you are using koa-views you can use the method renderView \n   * to render a view that match, instead use ctx.render('folder/index.ejs') use ctx.render('index.ejs')\n   * your view have to be in a folder with the same name of the controller\n   * for example TestController the method match only Test in lower case\n  */\n  allView(ctx) {\n    return ctx.renderView(\"index.ejs\", { name: 'my awsome test' })\n  }\n\n}\n```\n\nsee test folder for more examples \n\nBasic usage:\n  `of controllerRoutes`\n  this get all the files in `/app/controllers/` by default \n  \n\n```javascript\n  const Koa = require('koa');\n  const app = new Koa();\n\n  //import this\n  const { controllerRoutes } = require('koa2-controller-router')\n  //find in the default path and set props to the routes\n  app.use(new controllerRoutes({props:{ db:'db conection',...etc }}).routes())\n\n  //find in a diferent path and diferent prefix\n  const privateControllers = new controllerRoutes({\n    absolutePath: __dirname + '/app/controllers/private/',\n    prefix: '/v2'\n  })\n  \n  app.use(privateControllers.routes())\n\n  app.listen(3000, () =\u003e {\n    console.log(\"listen\")\n  })\n```\n## Testing\n\n```sh\nnpm run test\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapdilla%2Fkoa2-controller","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcapdilla%2Fkoa2-controller","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapdilla%2Fkoa2-controller/lists"}