bun-route

A fast, Express-like router for the high-performance bun.serve() HTTP server.

bun-route leverages Bun.js's powerful bun.serve to deliver a fast, familiar, and reliable routing experience. It provides developers with an easy-to-use, Express-like API, tailored for high-performance applications built with Bun.js.

At the time of bun-route's creation, Bun.js did not include a built-in router, so bun-route was designed as a lightweight, dependency-free solution to fill that gap.

features

life improvement

• wildcards: Can handle double wildcards (**) as any recursive path and single wildcards (*) as any path part. It also provides a path parameter string array". If enabled, cookies can also automatically be set/unset to the response headers.
• static-serve: Serves static files via a middleware (example).
• dump-router: You can create a string router dump that lists the defined routes. If you provide a bun server, it also adds a server-is-running-on message.
• basic-auth: Protects the following via HTTP basic auth (example).
• cookie-handling: Cookie parsing can be enabled via a middleware (example).
• redirect-handler: You can redirect via the ResponseBuilder or via a redirect middleware (example).
• websocket-support: Can handle websocket request via a middleware (example).

performance

• non-async-first: Tries to resolve a request in a non-async way until an async handler is hit.
• merged-routes: If 2 or more routes are defined one after the other with the same method and path, they will be merged into a single handler to avoid re-checking.
• method-enum: You just write GET, but in the background it is converted to an enum.
  This is for faster method comparison.

usage

install

Install typescript source from GitHub:

bun i github:NobleMajo/bun-route

or compiled javascript from the npm registry:

npm i bun-route

import

import { Router } from "bun-route";

example

import { Router } from "bun-route";

const router = new Router()

// handles GET requests to /
router.get("/", (req, res) => {
    res.send("Root request")
})

// use the native bun.serve function the router as request handler
const server = Bun.serve({
    fetch: router.handle,
})

// dumps router routes and server-is-running-on message
console.info(router.dump(server))

examples

Checkout the bun-route examples:

• simple example
• static-serve example
• websocket example
• redirect example
• cookies example
• basic auth example

Run a example:

git clone https://github.com/NobleMajo/bun-route.git

bun run examples/simple.ts

tests

The router has build-in tests.

bun test

future features

Here are some feature ideas for future development:

• CORS-support: Configure CORS headers via a buildin middleware.
• router.serve: Serve/listen function to start the server via the router (first parameter should be the bun.serve options without fetch).
• websocket: Better websocket support with more origin request infos.

Contributing

Contributions to this project are welcome!
Interested users can refer to the guidelines provided in the CONTRIBUTING.md file to contribute to the project and help improve its functionality and features.

License

This project is licensed under the MIT license, providing users with flexibility and freedom to use and modify the software according to their needs.

Disclaimer

This project is provided without warranties.
Users are advised to review the accompanying license for more information on the terms of use and limitations of liability.