@marmeon/router

The typed router of Marmeon apps: routes and named routes, invokable controllers with their request definitions, route model binding, middleware, URLs and cookies.

Installation

Part of every new Marmeon app: pnpm create marmeon installs it.

Apps import its everyday names from @marmeon/http, which re-exports them: defineRoutes, defineRequest, defineMiddleware, Router, HttpContext, ContextOf and more. What @marmeon/http does not re-export, such as GLOBAL, comes from here.

A route file

import { defineRoutes } from '@marmeon/http';
import { ListNotesController } from './controllers/ListNotesController.ts';
import { ShowNoteController } from './controllers/ShowNoteController.ts';
import { StoreNoteController } from './controllers/StoreNoteController.ts';

export default defineRoutes((Route) => {
  Route.get('/notes', ListNotesController).name('notes.index');
  Route.post('/notes', StoreNoteController).name('notes.store');
  Route.get('/notes/:note', ShowNoteController).name('notes.show');
});

The module lists the file as routes in its definition. Route names are typed: a link or redirect to a name that does not exist is a compile error.

Documentation

• Routing
• Routing: route model binding
• Middleware
• Controllers
• Requests
• URL Generation
• HTTP Tests

MIT · part of Marmeon