These v19 docs are archived 🔒.
Go to the
latest docs home
or try if
this exact page is available
in the latest docs.
Class UrlParams
Helper object to read url params.
Available on $2sxc.urlParams
Package: Api.Js.SxcJs
Methods
get(string)
Get a param from the url, no matter if it's behind ? or #
If not found, will return an empty string ''
Declaration
function get(name: string)Parameters
| Type | Name | Description |
|---|---|---|
| string | name |
Returns
| Type | Description |
|---|---|
| string |
isDebug()
Checks if debug is enabled in the URL
Declaration
function isDebug()Returns
| Type | Description |
|---|---|
| boolean |
require(string)
Get a required param from the url, no matter if it's behind ? or # Will throw an error if not found
Declaration
function require(name: string)Parameters
| Type | Name | Description |
|---|---|---|
| string | name |
Returns
| Type | Description |
|---|---|
| string |