itty-router

A ~460 byte router, designed to make beautiful APIs anywhere.
GitHub
1.81k
Created 5 years ago, last commit 4 months ago
31 contributors
707 commits
Stars added on GitHub, month by month
N/A
N/A
N/A
12
1
2
3
4
5
6
7
8
9
10
11
2023
2024
Stars added on GitHub, per day, on average
Yesterday
=
Last week
+0.4
/day
Last month
+0.6
/day
npmPackage on NPM
Monthly downloads on NPM
12
1
2
3
4
5
6
7
8
9
10
11
2023
2024
No dependencies
README

Itty Router

Version Bundle Size Build Status Coverage Downloads Issues Discord Github Follow @ittydev


An ultra-tiny API microrouter, for use when size matters (e.g. Cloudflare Workers).

Features

  • Tiny. Routers from ~450 bytes to a ~970 bytes batteries-included version (~240-500x smaller than Express.js).
  • TypeScript. Powerfully (and flexibly) typed for any environment.
  • Route-parsing & query parsing.
  • Middleware. Use ours or write your own.
  • 100% Test Coverage. Bulletproof for production peace-of-mind.
  • Designed specifically for serverless (but works anywhere).
  • No assumptions. Return anything; pass in anything.
  • Future-proof. HTTP methods not-yet-invented already work with it.

Example

import { AutoRouter } from 'itty-router' // ~1kB

const router = AutoRouter()

router
  .get('/hello/:name', ({ name }) => `Hello, ${name}!`)
  .get('/json', () => [1,2,3])
  .get('/promises', () => Promise.resolve('foo'))

export default router

// that's it ^-^

Need Help?

Complete API documentation is available on itty.dev, or join our Discord channel to chat with community members for quick help!

Join the Discussion!

Have a question? Suggestion? Idea? Complaint? Want to send a gift basket? Join us on Discord!

A Special Thanks ❤️

As the community and contributor list has grown (and thus an individualized list here is no longer easily maintainable), I'd like to thank each and every one of you for making itty far greater than its humble origins. The robustness you see today, the careful consideration of every byte spent on features, the API choices, the code-golfing itself... are all thanks to the efforts and feedback from the community. I'd especially like to thank the core contributors and PR-authors, as well as the fantastic folks on the itty Discord group, for their tireless work refining this little beast and answering community questions.