The example below shows how to use this package in a class. It is advised to create a separate file for each set of routes and export the routes as shown below. Supported types for parameters are string, number, boolean, ObjectID and Date which means these types will automatically be type-checked. For more complex types, the type of the parameter cannot be assumed and should be checked manually.

import express from "express";

import { ExpressError, get, post, use } from "express-requesthandler";

export class Routes {
    // The router which will be populated by the generated routes
    public static router: express.Router = express.Router();

    // This is a GET route which gets its parameters from the query parameters
    @get()
    public static someRoute1(param1: string, param2: number): void {
        // Throw an ExpressError to set the status code of the response
        throw new ExpressError("Not found", 404);
    }

    // This is a POST route which gets its parameters from either the query parameters or the body
    @post()
    public static someRoute2(param1: string, param2: number): void {

    }

    // This is a middleware route
    // The return value of this route will be available in the next route under the identifier "user"
    @use(true)
    public static someRoute3(param1: string, param2: number): { user: string } {
        return { user: "userId" };
    }

    // This is an example of how to use the previous middleware function
    @get()
    public static someRoute4(user: string): void {
        // The parameter user should now be "userId"
    }
}

export default Routes.router;

The router can then be used as follows.

import express from "express";
import routes from "./routes";

const app = express();

app.use("/routes", routes);

// Listen
app.listen(3000, () => {
    console.log("Listening on port 3000");
});