api.service.RoutesPerMethod

This service implements a class for collecting defined routes grouped by their HTTP method. It is essential in Hitchy's attempt to optimize defined routes for improved request dispatching.

Constructor

An instance of this class can be constructed without any arguments.

const byMethod = new api.service.RoutesPerMethod();

Properties

isAdjustable

This boolean property indicates whether additional routes may be collected using append() and concat() or not.

It is true initially, but gets false once optimizeByPrefix() has been invoked.

Methods

append()

This method is invoked by Hitchy's core to basically collect all defined routes and have them separated by HTTP method as a first step of routing optimization process.

It is invoked with a controller route or a policy route. It is inspecting the route's association with a particular HTTP method or with all HTTP methods and adds it to lists of routes separately maintained by HTTP method.

const route = byMethod.append( route );

It is returning the appended route for daisy-chaining calls.

concat()

This method is used by Hitchy's core to merge routes separately collected by their HTTP method before. It is invoked with another instance of this class to append all routes of that instance to the current one.

const routesPerMethod = byMethod.concat( furtherRoutesPerMethod );

It is returning the current instance of this class for daisy-chaining calls.

dump()

This method may be invoked to create a string describing all currently selected routes. The returned string is e.g. used by Hitchy's core to log the result of collecting and compiling routes for debugging purposes.

console.log( byMethod.dump() );

onMethod()

This method retrieves all previously collected routes associated with an HTTP method given as argument.

const byPrefix = byMethod.onMethd( "GET" );

It is implicitly invoking optimizeByPrefix() on first invocation and thus ends support for appending further routes.

An instance of RoutesPerPrefix is returned managing all routes associated with selected method. This always includes routes that haven't been bound to a particular method per definition.

optimizeByPrefix()

This method is triggering next step in routing optimizations.

First, it disables the support for adding further routes using append() or concat() by irreversibly re-defining property isAdjustable to be always false. Next, it replaces the flat list of routes previously collected for every method with a populated instance of RoutesPerPrefix managing the same routes in an optimized way.

byMethod.optimizeByPrefix( true );

A boolean value is provided as sole argument to indicate whether routes grouped by their prefix should be sorted from more specific prefixes to more generic ones (if true) or from more generic prefixes to more specific ones (if false). The switch is essential in processing late policy routes in opposite order.

The method returns current instance for daisy-chaining calls.