API reference documentation

API reference

Functions

isSameRelativeUrl(url1:String, url2:String)

// TODO

Example

// TODO

url(url:String[, baseUrl:String])

Gets a formatted url concatening baseUrl and url. If baseUrl is omitted, it will look for configs.baseUrl.

Example

utilities.url('/home-page', '/') // /home-page
utilities.url('/home-page', '/v3/') // /v3/home-page

patternWithQueryString(url:String)

Appends the query string pattern to the provided url.

Example

utilities.patternWithQueryString('/home-page') // /home-page:?queryString:

joinUrlParts(...)

Joins multiple strings to form an url.

Example

var id = 3; // fetch some id from the database.
utilities.joinUrlParts('episodes', id, 'edit') // /episodes/3/edit