►

Class: Router

'brixy.mvc.Router'~ Router

new Router (RouteTypeopt)

Router object. It holds a repository of named routes.

Parameters:
Name Type Attributes Default Description
RouteType function <optional>
 module:'brixy.mvc.Router'~Route

route constructor (optional)
Throws:

  • Exception

Source:

Methods

addRoute (name, route)

Adds a new route. The correct format is verified.

Parameters:
Name Type Description
name string

Route name.
route Object

Route object.
Throws:

  • Exception if route has an invalid format.

Source:

createRoute (request) → {Object}

Creates the Route object from request. This one is not saved as named route.

Parameters:
Name Type Description
request string | Object

Request string or route-like object.
Throws:

  • Exception on error.

Returns:
  • Object :

    Route object.

Source:

getRoute (name) → {Object|null}

Gets a saved Route object or null.

Parameters:
Name Type Description
name string

Route name.
Returns:
  • Object | null :

    Route object or null.

Source:

hasRoute (name) → {boolean}

Checks if the router has a saved route of this name.

Parameters:
Name Type Description
name string

Route name.
Returns:
  • boolean
Source:

removeRoute (name)

Removes the route.

Parameters:
Name Type Description
name string

Route name.
Source:

setRoutes (routes)

Saves a set of routes and replaces existing route set. The correct format is verified.

Parameters:
Name Type Description
routes Object

Set of routes in the form {name1: route1, name2: route2, ...}.
Throws:

  • Exception if routes has an invalid format.

Source:

toString () → {string}

Returns a string representation of the object.

Returns:
  • string
Source:
Modules
Classes
Namespaces