HyperBun is meant for Bun runtimes, it will not work in Node / Deno.

Getting started

bun add hyperbun

Example

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

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

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

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

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

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