Whether to activate versbose mode. Useful for debugging the router.

Shortcut function for attaching an action to any request method. Full function: on

Shortcut function for attaching an action to head requests. Full function: on

router.head("/location/:name/status", (context, _next) => {
	context.send.plain(200, `Coming in from ${context.params.type} - status ok!`);
});

Shortcut function for attaching an action to get requests. Full function: on

router.get("/tree/:type", (context, _next) => {
	context.send.plain(200, `Hello, I am a ${context.params.type}`);
});

Shortcut function for attaching an action to post requests. Full function: on

router.post("/loaction/:name/update", (context, _next) => {
	context.send.plain(501, `Hello from ${context.params.name}! I don't yet support updating my firmware.\nYou asked me to update to version ${context.post_data.version}.`);
	// See https://github.com/sbrl/powahroot/blob/master/examples/parse_post_data.mjs for an example of parsing post data with middleware that works with the above (context.post_data is not created automatically by powahroot)
});

Shortcut function for attaching an action to put requests. Full function: on

Shortcut function for attaching an action to delete requests. Full function: on

Shortcut function for attaching an action to options requests. Full function: on

router.options("/location/:name/status", (context, _next) => {
	context.send.plain(200, `I support these actions:\n - GET: Get my status\n - POST: Set my status\n - OPTIONS: Show this message`);;
});

Execute the specified action for requests matching the given parameters. TODO: Consider merging with on_all and refactoring to take an object literal which we can destructure instead

router.on(["get"], "/garden/:vegetable", (context) => {
	context.send(201, `Planted ${context.params.vegetable}`);
});

Adds a route that matches against every request. Usually useful for middleware (e.g. error handlers, request loggers, authentication handlers, etc.).

router.on_all((context) => {
	context.send.plain(200, "Hello, world!");
});

Runs the specified action for requests if the provided testing function returns true.

Handles the specified request.

const server = http.createServer((request, response) => {
	router.handle(request, response);
});
server.listen(3500, "127.0.0.1", () => console.log("Listening on http://127.0.0.1:3500/"));

Iterates over all the generated middleware.

The Node.JS request object

Type: http.ClientRequest

The Node.JS response object

Type: http.ServerResponse

The parsed request URL

Type: URL

The url parameters parsed out by the router

Type: Object

An object containing some utitlity methods for quickly sending responses

Type: Sender

The environment object. State variables that need to be attached to a specific request can go in here.

Type: Object

Sends a HTML response, rendering a NightInk template. Don't forget to await this!

Sends a plain text response.

Sends a redirect.

Whether the user is logged in or not.

Type: Boolean

The user's name. Guaranteed to be specified - if only as "anonymous".

Type: String

The parsed cookie object

Type: Object

The parsed post data as an object, if applicable.

Type: (Object | null)

Whether we should handle popstate events or not. @type {Boolean}

Sets the function to execute when no other route could be matched.

router.add_404((path) => console.log(`Oops! Couldn't find a route to handle '${path}'.`));

Adds a route to the router.

router.add_page("/add/vegetable/:name/:weight", (params) => console.log(`We added a ${params.name} with a weight of ${params.weight}g.`));

Manually navigate to a given path.

router.navigate("/add/carrot/frederick/10001");

Navigate to the current URL's hash value - i.e. the bit after the '#' symbol in the URL.

router.navigate_current_hash();