{"id":17750584,"url":"https://github.com/nuintun/koa-interceptors","last_synced_at":"2025-04-01T09:39:18.737Z","repository":{"id":57150343,"uuid":"69312924","full_name":"nuintun/koa-interceptors","owner":"nuintun","description":"An Interceptors middleware for koa2","archived":false,"fork":false,"pushed_at":"2018-04-12T09:18:32.000Z","size":26,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-08-31T08:38:09.591Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/nuintun.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}},"created_at":"2016-09-27T02:47:59.000Z","updated_at":"2019-01-02T05:29:25.000Z","dependencies_parsed_at":"2022-09-03T18:02:09.388Z","dependency_job_id":null,"html_url":"https://github.com/nuintun/koa-interceptors","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuintun%2Fkoa-interceptors","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuintun%2Fkoa-interceptors/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuintun%2Fkoa-interceptors/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuintun%2Fkoa-interceptors/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nuintun","download_url":"https://codeload.github.com/nuintun/koa-interceptors/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246620135,"owners_count":20806716,"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":[],"created_at":"2024-10-26T12:22:45.217Z","updated_at":"2025-04-01T09:39:18.712Z","avatar_url":"https://github.com/nuintun.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# koa-interceptors\n\n\u003eAn interceptors middleware for koa2\n\u003e\n\u003e[![NPM Version][npm-image]][npm-url]\n\u003e[![Download Status][download-image]][npm-url]\n\u003e[![Dependencies][david-image]][david-url]\n\n### Introduction:\nThe interceptor automatically associates the router with the controller.\n\n### Usage\n`app.js`\n```js\n'use strict';\n\n// modules\nconst koa = require('koa');\nconst convert = require('koa-convert');\nconst session = require('koa-session');\nconst Interceptors = require('koa-interceptors');\n\n// app\nconst app = new koa();\n// interceptors\nconst interceptors = new Interceptors();\n\n// use session\ninterceptors.use(convert(session()));\n\n// load routes\napp.use(interceptors.routes());\n```\n\n`/routers/home/login.js`\n```js\n'use strict';\n\nmodule.exports = {\n  '/login': [\n    {\n      action: 'login' // page action\n    },\n    {\n      method: 'post', // if get can be omitted\n      action: 'validate-login' // page action\n    }\n  ]\n};\n```\n\n`/controllers/home/login.js`\n```js\n'use strict';\n\nmodule.exports = {\n  login: ctx=\u003e{\n    // page action logic\n  },\n  'validate-login': ctx=\u003e{\n    // page action logic\n  },\n};\n```\n\n### Install\n```\n$ npm install koa-interceptors --save\n```\n\n### API\n##### Interceptors([routers, controllers, options])\n- `routers`: the routers base dir.\n- `controllers`: the controllers base dir.\n- `options`: the [koa-router][koa-router-url] options.\n\n##### Others see: [koa-router][koa-router-url]\n\n### Notice\nThe interceptor will add a property `routeData` on koa ctx.\n\n[npm-image]: http://img.shields.io/npm/v/koa-interceptors.svg?style=flat-square\n[npm-url]: https://www.npmjs.org/package/koa-interceptors\n[download-image]: http://img.shields.io/npm/dm/koa-interceptors.svg?style=flat-square\n[david-image]: http://img.shields.io/david/nuintun/koa-interceptors.svg?style=flat-square\n[david-url]: https://david-dm.org/nuintun/koa-interceptors\n[koa-router-url]: https://github.com/alexmingoia/koa-router\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuintun%2Fkoa-interceptors","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnuintun%2Fkoa-interceptors","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuintun%2Fkoa-interceptors/lists"}