w2utils.parseRoute

Returns parsed route object.

parseRoute(route)

route

string dynamic route

Returns object.

Description

The route argument is a string, for example:

xxxxxxxxxx
 
w2utils.parseRoute('/view/(:id)/details/:sub');
​

Returns

xxxxxxxxxx
 
route = {
    path: /^\/view(?:\/(?:([^\/]+?)))\/details\/(?:([^\/]+?))$/i,
    keys:[{
        "name": "id",
        "optional": false
    }, {
        "name": "sub",
        "optional":false
    }]
}
​

You can also define some routes as optional:

xxxxxxxxxx
 
var route = w2utils.parseRoute('/view/:id/details/:sub?')
console.log(route);
​

Returns

xxxxxxxxxx
 
route = {
    path: /^\/view(?:\/(?:([^\/]+?)))\/details(?:\/([^\/]+?))?$/i,
    keys:[{
        "name": "id",
        "optional": false
    }, {
        "name": "sub",
        "optional":true
    }]
}
​

The "path" returned can be used as a regular expression to compare if path matches.

This method is used internally to process routes for w2toolbar, w2sidebar, w2tabs, etc.

w2utils.parseRoute

Description

User Comments