Plugins

Routup is minimalistic by design. Plugins extend the framework with additional functionality that is not part of the core.

A plugin is an object with a name and an install method that receives the router instance.

Mounting

Mount a plugin globally:

router.use(myPlugin({ /* options */ }));

Mount a plugin on a specific path:

router.use('/api', myPlugin({ /* options */ }));

Writing a Plugin

Define a plugin as a factory function that returns a Plugin object:

import { defineCoreHandler } from 'routup';
import type { Plugin } from 'routup';

export type Options = {
    path?: string;
};

export function myPlugin(options: Options = {}): Plugin {
    const path = options.path || '/hello';

    return {
        name: 'myPlugin',
        install: (router) => {
            router.get(path, defineCoreHandler((event) => {
                return 'Hello from plugin!';
            }));
        }
    };
}

Using a Plugin

import { Router } from 'routup';
import { myPlugin } from '@routup/my-plugin';

const router = new Router();

router.use(myPlugin({ path: '/hello' }));

Ecosystem

Official plugins are available at GitHub.

Name	Description
assets	Serve static files from a directory
basic	Bundle of body, cookie, and query plugins
body	Read and parse the request body
cookie	Read/write cookies
decorators	Class, method, and parameter decorators
prometheus	Collect and serve Prometheus metrics
query	Parse URL query strings
rate-limit	Rate limit incoming requests
rate-limit-redis	Redis adapter for rate-limit
swagger	Serve Swagger/OpenAPI docs