RouteHandlerFunction

To learn how to use RouteHandlerFunction, see Server-Side Routing.

RouteHandlerFunction takes:

• a ViewRequest
• a HandlerContext

It returns a RouteHandlerViewResponse.

A ViewRequest object has to have:

• a URL
• a path (requestPath)

ViewRequest can optionally have any number of:

• parameters (params)
• queries (query)

For example, the ViewRequest object for the request get http://www.example.com/custom/thing?sort=desc looks like this.

A HandlerContext object has to have:

• a route in the form of an LwrRoute or an LwrErrorRoute object
• a RouteHandlerViewApi call

The RouteHandlerViewApi calls the functions:

• hasViewResponse
  • Takes a RouteHandlerView and a Record
  • Returns a boolean
• getViewResponse
  • Takes a RouteHandlerView and a Record
  • Returns a RouteHandlerViewResponse or undefined

A RouteHandlerView object has this syntax:

See Also

• Server-Side Routing: Route Handler Functions