{"id":16454693,"url":"https://github.com/bolajiolajide/koii","last_synced_at":"2025-03-16T17:37:08.482Z","repository":{"id":33958043,"uuid":"163583903","full_name":"BolajiOlajide/koii","owner":"BolajiOlajide","description":"A simple middleware for displaying routes in an express application","archived":false,"fork":false,"pushed_at":"2023-11-01T07:13:11.000Z","size":1735,"stargazers_count":76,"open_issues_count":3,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-09-13T12:39:06.005Z","etag":null,"topics":["express","javascript","middleware","route","routing"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/koii","language":"TypeScript","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/BolajiOlajide.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-12-30T11:57:40.000Z","updated_at":"2024-09-02T22:20:48.000Z","dependencies_parsed_at":"2023-11-01T06:27:07.741Z","dependency_job_id":null,"html_url":"https://github.com/BolajiOlajide/koii","commit_stats":{"total_commits":123,"total_committers":7,"mean_commits":"17.571428571428573","dds":0.6097560975609756,"last_synced_commit":"84cf3e487200133832a3ae321f601e77f24a826b"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BolajiOlajide%2Fkoii","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BolajiOlajide%2Fkoii/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BolajiOlajide%2Fkoii/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BolajiOlajide%2Fkoii/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BolajiOlajide","download_url":"https://codeload.github.com/BolajiOlajide/koii/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219861652,"owners_count":16555988,"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":["express","javascript","middleware","route","routing"],"created_at":"2024-10-11T10:19:41.057Z","updated_at":"2024-10-11T10:19:42.219Z","avatar_url":"https://github.com/BolajiOlajide.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KOII\n\n[![star this repo](http://githubbadges.com/star.svg?user=BolajiOlajide\u0026repo=koii\u0026style=flat)](https://github.com/BolajiOlajide/koii)\n[![fork this repo](http://githubbadges.com/fork.svg?user=BolajiOlajide\u0026repo=koii\u0026style=flat)](https://github.com/BolajiOlajide/koii/fork)\n[![npm](https://img.shields.io/npm/v/koii.svg)](https://www.npmjs.com/package/koii)\n[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=102)](https://github.com/ellerbrock/open-source-badge/)\n[![Open Source Love](https://badges.frapsoft.com/os/mit/mit.svg?v=102)](https://github.com/ellerbrock/open-source-badge/)\n\nKoii is a simple ExpressJS middleware used to print all routes accessible in an application to the console on start.\n\n![Koii is inspired by Jackie and the fish](images/koi.jpg)\n\n## Install\n\n```console\nnpm install koii\n```\n\n## Usage\n\nTo use **Koii** simply add it as a middleware in your express application. To do that, you need to first import **Koii**.\n\nThis can be done with requireJS or the ES6 import statements as shown below:\n\n```js\n// we require this way because koii is currently exported as an esModule\nconst koii = require('koii');\n```\n\nOR\n\n```js\nimport koii from 'koii';\n```\n\nOnce this is done, you can add the middleware with the statement\n\n```js\napp.use(koii)\n```\n\nAn example can be found in [this github gist](https://gist.github.com/BolajiOlajide/7649c1f7205fe9b95bb011fe5ef89721).\nEnsure you do this after all your route definitions, if not the middleware won't have access to the routes defined.\n\nRead more about Koii [here](https://medium.com/backticks-tildes/introducing-koii-d556657723c)\n\nInspired by [@danielb2](https://github.com/danielb2)'s [Blipp plugin](https://www.npmjs.com/package/blipp) for HapiJS\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbolajiolajide%2Fkoii","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbolajiolajide%2Fkoii","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbolajiolajide%2Fkoii/lists"}