@philiprehberger/typed-router

Framework-agnostic typed URL routing with path parameter extraction

Installation

npm install @philiprehberger/typed-router

Usage

import { createRouter } from '@philiprehberger/typed-router';

const router = createRouter();

router.add('GET', '/users', () => listUsers());
router.add('GET', '/users/:id', (params) => getUser(params.id));
router.add('POST', '/users', () => createUser());
router.add('PUT', '/users/:id/roles/:role', (params) => setRole(params.id, params.role));

const match = router.match('GET', '/users/123');
if (match) {
  match.params; // { id: '123' }
  match.handler(match.params);
}

router.routes(); // list all registered routes

API

| Export | Description | |--------|-------------| | createRouter() | Create a new router instance |

Router

| Method | Description | |--------|-------------| | add(method, path, handler) | Register a route with :param placeholders | | match(method, url) | Find matching route, returns { handler, params } or null | | routes() | List all registered routes |

Development

npm install
npm run build
npm test

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT