Routes Server Framework

Common errors

• TypeError: app.get is not a function

  cause The main 'Application' instance might not directly expose HTTP method methods (e.g., .get, .post) or the module might export a function to create such an instance.
  fix Verify the exact API for defining routes. It's common for frameworks to use a 'router' instance for methods, which is then 'used' by the application, or for methods to be on a returned object from `new Application()`.

• Cannot read properties of undefined (reading 'body')

  cause The request body parsing middleware has likely not been configured or is not working correctly, meaning `req.body` has not been populated.
  fix Ensure you have included and configured the correct body parsing middleware (e.g., for JSON, URL-encoded data) before your route handlers attempt to access `req.body`.

Warnings

• gotcha Careless ordering of middleware or routes can lead to unexpected behavior, where a more general route/middleware might catch a request before a specific one. Always define more specific routes and error-handling middleware before general ones.
  Fix: Structure your route definitions from most specific to least specific. Place global error handlers and catch-all routes last.
• gotcha Asynchronous operations within middleware or route handlers must be correctly awaited or chained with promises to ensure the response is sent only after all processing is complete, preventing premature responses or unhandled errors.
  Fix: Use `async/await` with `try/catch` blocks or promise chains (`.then().catch()`) to manage asynchronous logic flow within handlers.
• gotcha Without explicit documentation, it's unclear how the framework handles body parsing for different content types (JSON, URL-encoded, multipart). Attempting to access `req.body` directly without proper setup might result in `undefined`.
  Fix: It is highly probable that you need to implement or import a separate body parsing middleware (e.g., `body-parser` if compatible, or a custom solution) and apply it globally or to specific routes.

Install

• npm install routes-framework npm
• yarn add routes-framework yarn
• pnpm add routes-framework pnpm

Imports

• Application
  wrong:

  const { Application } = require('routes-framework')

  correct:

  import { Application } from 'routes-framework'

  Assumed primary server class/function. ESM is the recommended import style for modern Node.js frameworks.
• Router
  wrong:

  import Router from 'routes-framework/Router'

  correct:

  import { Router } from 'routes-framework'

  Assumed dedicated class for defining route groups or modular routing, typically a named export.
• Request

  import type { Request, Response } from 'routes-framework'

  Type imports for core HTTP objects, often destructured from the main package or a dedicated 'types' submodule.

Quickstart

Demonstrates setting up a basic HTTP server, defining routes, using middleware, and mounting a router in the `routes-framework`.

import { Application, Router } from 'routes-framework';
import { createServer } from 'http';

interface CustomRequest extends Request {
  userId?: string;
}

const app = new Application();
const apiRouter = new Router();

// A simple middleware function
apiRouter.use((req: CustomRequest, res, next) => {
  console.log('API Request received:', req.method, req.url);
  // Simulate authentication
  if (req.headers['authorization'] === 'Bearer secret-token') {
    req.userId = 'user123';
    next();
  } else {
    res.statusCode = 401;
    res.end('Unauthorized');
  }
});

// Define a route on the router
apiRouter.get('/hello', (req: CustomRequest, res) => {
  res.statusCode = 200;
  res.setHeader('Content-Type', 'text/plain');
  res.end(`Hello from API, User ID: ${req.userId}`);
});

// Mount the router under a base path
app.use('/api', apiRouter);

// A basic root route
app.get('/', (req, res) => {
  res.statusCode = 200;
  res.setHeader('Content-Type', 'text/plain');
  res.end('Welcome to Routes Framework!');
});

// Start the server
const PORT = process.env.PORT ?? 3000;
const server = createServer(app.handleRequest.bind(app)); // Assuming an 'handleRequest' method

server.listen(PORT, () => {
  console.log(`Server running on http://localhost:${PORT}`);
  console.log('Try: curl http://localhost:3000');
  console.log('Try: curl -H "Authorization: Bearer secret-token" http://localhost:3000/api/hello');
  console.log('Try: curl http://localhost:3000/api/hello');
});