https://github.com/kwhitley/itty-router

A little router.
https://github.com/kwhitley/itty-router

api cloudflare cloudflare-workers edge itty-router javascript middleware router serverless service-worker

Last synced: 4 days ago
JSON representation

A little router.

• Host: GitHub
• URL: https://github.com/kwhitley/itty-router
• Owner: kwhitley
• License: mit
• Created: 2020-04-15T15:32:28.000Z (over 4 years ago)
• Default Branch: v5.x
• Last Pushed: 2024-09-23T23:09:39.000Z (3 months ago)
• Last Synced: 2024-10-29T15:34:41.472Z (about 2 months ago)
• Topics: api, cloudflare, cloudflare-workers, edge, itty-router, javascript, middleware, router, serverless, service-worker
• Language: TypeScript
• Homepage:
• Size: 1.89 MB
• Stars: 1,781
• Watchers: 14
• Forks: 78
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-list - itty-router

README

        





  

     

  



[![Version](https://img.shields.io/npm/v/itty-router.svg?style=flat-square)](https://npmjs.com/package/itty-router)

[![Bundle Size](https://deno.bundlejs.com/?q=itty-router/Router&badge&badge-style=flat-square)](https://deno.bundlejs.com/?q=itty-router)

[![Build Status](https://img.shields.io/github/actions/workflow/status/kwhitley/itty-router/verify.yml?style=flat-square)](https://coveralls.io/github/kwhitley/itty-router)

[![Coverage](https://img.shields.io/coveralls/github/kwhitley/itty-router?style=flat-square)](https://coveralls.io/github/kwhitley/itty-router)

[![Downloads](https://img.shields.io/npm/dw/itty-router?style=flat-square)](https://npmjs.com/package/itty-router)

[![Issues](https://img.shields.io/github/issues/kwhitley/itty-router?style=flat-square)](https://coveralls.io/github/kwhitley/itty-router)

[![Discord](https://img.shields.io/discord/832353585802903572?label=Discord&logo=Discord&style=flat-square&logoColor=fff)](https://discord.gg/53vyrZAu9u)

[![Github](https://img.shields.io/github/stars/kwhitley/itty-router?style=social)](https://github.com/kwhitley/itty-router)

[![Follow @ittydev](https://img.shields.io/twitter/follow/ittydev.svg?style=social&label=Follow)](https://www.twitter.com/ittydev)

###  [v5 Documentation](https://itty.dev/itty-router)  |   [v4 -> v5 Migration Guide](https://itty.dev/itty-router/migrations/v4-v5)  |   [Discord](https://discord.gg/53vyrZAu9u) 

---

An ultra-tiny API microrouter, for use when [size matters](https://github.com/TigersWay/cloudflare-playground) (e.g. [Cloudflare Workers](https://developers.cloudflare.com/workers/)).

## Features

- Tiny. Routers from [~450 bytes](https://itty.dev/itty-router/routers/ittyrouter) to a [~970 bytes](https://itty.dev/itty-router/routers/autorouter) batteries-included version (~240-500x smaller than Express.js).

- [TypeScript](https://itty.dev/itty-router/typescript). Powerfully (and flexibly) typed for any environment.

- [Route-parsing](https://itty.dev/itty-router/route-patterns) & [query parsing](https://itty.dev/itty-router/query-params).

- [Middleware](https://itty.dev/itty-router/middleware). Use ours or write your own.

- [100% Test Coverage](https://coveralls.io/github/kwhitley/itty-router?branch=v5.x). 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

```js

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](https://itty.dev/itty-router) is available on [itty.dev](https://itty.dev/itty-router), or join our [Discord](https://discord.gg/53vyrZAu9u) 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](https://discord.gg/53vyrZAu9u)!

# A Special Thanks :heart:

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](https://discord.gg/53vyrZAu9u) group, for their tireless work refining this little beast and answering community questions.