@bearnjs/rest

A fast and lightweight HTTP framework built from scratch in TypeScript.

Installation

npm install @bearnjs/rest
# or
yarn add @bearnjs/rest
# or
pnpm add @bearnjs/rest
Copy

Quick Start

import createApp from '@bearnjs/rest';

const app = createApp({
  port: 3000,
  cors: {
    origin: 'http://localhost:3000',
    methods: ['GET', 'POST'],
  },
});

app.get('/hello', (req, res) => {
  res.json({ message: 'Hello World!' });
});

app.start();
Copy

Features

• TypeScript first
• Decorator-based routing
• Built-in CORS support
• Request/response enhancement
• Error handling
• Middleware support
• Lightweight and fast

Basic Usage

Creating an App

import createApp from '@bearnjs/rest';

const app = createApp({
  port: 3000,
  host: 'localhost',
  appName: 'My API',
  appVersion: '1.0.0',
});
Copy

Routes

app.get('/users', (req, res) => {
  res.json({ users: [] });
});

app.post('/users', (req, res) => {
  const user = req.body;
  res.status(201).json({ user });
});

app.get('/users/:id', (req, res) => {
  const { id } = req.params;
  res.json({ id });
});
Copy

Middleware

app.use((req, res, next) => {
  console.log(`${req.method} ${req.url}`);
  next();
});
Copy

Decorator-based Controllers

import { Controller, Get, Post, Put, Delete } from '@bearnjs/rest';
import type { Request, Response } from '@bearnjs/rest';

@Controller('/users')
class UserController {
  @Get('/')
  getAllUsers(req: Request, res: Response) {
    res.json({ users: [] });
  }

  @Get('/:id')
  getUserById(req: Request, res: Response) {
    const { id } = req.params;
    res.json({ id });
  }

  @Post('/')
  createUser(req: Request, res: Response) {
    const user = req.body;
    res.status(201).json({ user });
  }

  @Put('/:id')
  updateUser(req: Request, res: Response) {
    const { id } = req.params;
    const updates = req.body;
    res.json({ id, updates });
  }

  @Delete('/:id')
  deleteUser(req: Request, res: Response) {
    const { id } = req.params;
    res.status(204).send();
  }
}

// Controllers are automatically registered when the app starts
app.start();
Copy

Error Handling

app.onError((err, req, res, next) => {
  console.error(err);
  res.status(500).json({ error: 'Something went wrong' });
});
Copy

Requirements

• Node.js >= 20.0.0

License

MIT