root()

Signature

root() — returns struct

Available in: mapper Category: Routing

Description

Create a route that matches the root of its current context. This mapper can be used for the application’s web root (or home page), or it can generate a route for the root of a namespace or other path scoping mapper.

Parameters

Name	Type	Required	Default	Description
to	string	no	—	Set controller##action combination to map the route to. You may use either this argument or a combination of controller and action.
mapFormat	boolean	no	—	Set to true to include the format (e.g. .json) in the route.

Examples

<cfscript>

mapper()
    .namespace("api")
        // Map the root of the `api` folder to the `index` action of the `apis`
        // controller.
        .root(controller="apis", action="index")
    .end()

    // Map the root of the application to the `show` action of the `dashboards`
    // controller.
    .root(to="dashboards##show")
.end();

</cfscript>