https://github.com/Eckhardt-D/hyperbun
https://github.com/Eckhardt-D/hyperbun
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/Eckhardt-D/hyperbun
- Owner: Eckhardt-D
- Created: 2022-07-07T14:13:53.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-13T14:47:56.000Z (about 2 years ago)
- Last Synced: 2025-03-30T12:41:30.575Z (2 months ago)
- Language: TypeScript
- Size: 218 KB
- Stars: 18
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-bun - Hyperbun - A simple HTTP routing library built on top of Bun's built in HTTP solution (Frameworks & Libraries)
README
# HyperBun is meant for Bun runtimes, it will not work in Node / Deno.
A simple HTTP routing library built on top of Bun's built in HTTP solution.
## Getting started
bun add hyperbun
## Example
```ts
import {createServer} from 'hyperbun';
const server = createServer();
server.middleware((request, context) => {
console.log('Just a simple middleware...');
});
server.middleware((request, context) => {
return Error('Oops, I returned a 500.');
});
server.get('/json', (request, context) => {
return {
hello: 'I will automatically become a JSON response...'
}
});
server.get('/text', (request, context) => {
return "Hello, I will be a text/html response...";
});
server.listen({
port: 3000,
hostname: '0.0.0.0'
});
```
## Request Context
Includes `{params: {}, query: {}}` by default. More to come.
```ts
import {createServer} from 'hyperbun'
const server = createServer();
server.middleware((request, context) => {
context.auth = {user: '1234'};
});
// /home?search=movies
server.get('/home', (_, context) => {
console.log(context.query) // { search: "movies" }
return 'OK';
})
server.get('/private', (_, context) => {
if (context.auth?.user !== '1234') {
// Return your own custom responses too.
return new Response('unauthorized', {
status: 401,
})
}
return {
private: 'data',
}
})
server.listen({port: 3000});
```
## Dynamic routes with params
```ts
import {createServer} from 'hyperbun';
const server = createServer();
server.post('/users/:userId', async (request, context) => {
const {userId} = context.params;
const updatePayload = await request.json();
await UserModel.updateById(userId, updatePayload);
return { success: "true" };
});
server.listen({
port: 3000,
hostname: "0.0.0.0",
});
```
## Send a file response
```ts
import {createServer, asAttachment} from 'hyperbun';
const server = createServer();
server.get('/file', () => {
return Bun.file('./test-file.txt'); // Inline
})
server.get('/file', () => {
return asAttachment('./test-file.txt', { // Attachment (download)
name: 'helloworld.txt'
});
})
server.listen({
port: 3000,
hostname: '0.0.0.0',
});
```
## Consuming a request body
```ts
import {createServer} from 'hyperbun'
const server = createServer();
server.post('/users/add', async (request, context) => {
const user = await request.json();
const result = await database.create(user);
return result;
});
```
## Create multiple Routers and use on base path
```ts
import {createServer, createRouter} from 'hyperbun';
const server = createServer();
const router1 = createRouter();
const router2 = createRouter();
server.get('/', () => new Response('/ server main router'));
router1.get('/', () => new Response('/users router'));
router2.get('/', () => new Response('/posts router'));
server.use('/users', router1);
server.use('/posts', router2);
server.listen({
port: 3000,
})
```
## Available methods
These listeners will automatically match the route and method that you setup and respond with a 404 for ones you don't have.
`server.get`
`server.post`
`server.put`
`server.delete`
`server.patch`