A UrlMatcher instance to append as a child of the current UrlMatcher.
The URL path to match, e.g. $location.path().
URL search parameters, e.g. $location.search().
URL hash e.g. $location.hash().
The captured parameter values.
the values to substitute for the parameters in this pattern.
the formatted URL (path and optionally search part).
The object hash of parameters to validate.
Returns true if params validates, otherwise false.
Given a matcher, return an array with the matcher's path segments and path params, in order
Given a matcher, return an array with the matcher's path segments and path params, in order
Given a matcher, return an array with the matcher's query params
Given a matcher, return an array with the matcher's query params
Generated using TypeDoc
object
ui.router.util.type:UrlMatcher
Matches URLs against patterns and extracts named parameters from the path or the search part of the URL. A URL pattern consists of a path pattern, optionally followed by '?' and a list of search parameters. Multiple search parameter names are separated by '&'. Search parameters do not influence whether or not a URL is matched, but their values are passed through into the matched parameters returned by {@link ui.router.util.type:UrlMatcher#methods_exec exec}.
Path parameter placeholders can be specified using simple colon/catch-all syntax or curly brace syntax, which optionally allows a regular expression for the parameter to be specified:
':'name - colon placeholder'*'name - catch-all placeholder'{' name '}'- curly placeholder'{' name ':' regexp|type '}'- curly placeholder with regexp or type name. Should the regexp itself contain curly braces, they must be in matched pairs or escaped with a backslash.Parameter names may contain only word characters (latin letters, digits, and underscore) and must be unique within the pattern (across both path and search parameters). For colon placeholders or curly placeholders without an explicit regexp, a path parameter matches any number of characters other than '/'. For catch-all placeholders the path parameter matches any number of characters.
Examples:
'/hello/'- Matches only if the path is exactly '/hello/'. There is no special treatment for trailing slashes, and patterns have to match the entire path, not just a prefix.'/user/:id'- Matches '/user/bob' or '/user/1234!!!' or even '/user/' but not '/user' or '/user/bob/details'. The second path segment will be captured as the parameter 'id'.'/user/{id}'- Same as the previous example, but using curly brace syntax.'/user/{id:[^/]*}'- Same as the previous example.'/user/{id:[0-9a-fA-F]{1,8}}'- Similar to the previous example, but only matches if the id parameter consists of 1 to 8 hex digits.'/files/{path:.*}'- Matches any URL starting with '/files/' and captures the rest of the path into the parameter 'path'.'/files/*path'- ditto.'/calendar/{start:date}'- Matches "/calendar/2014-11-12" (because the pattern defined in the built-indateType matches2014-11-12) and provides a Date object in $stateParams.startThe pattern to compile into a matcher.
A configuration object hash
caseInsensitive-trueif URL matching should be case insensitive, otherwisefalse, the default value (for backward compatibility) isfalse.strict-falseif matching against a URL with a trailing slash should be treated as equivalent to a URL without a trailing slash, the default value istrue.{string} prefix A static prefix of this pattern. The matcher guarantees that any URL matching this matcher (i.e. any string for which {@link ui.router.util.type:UrlMatcher#methods_exec exec()} returns non-null) will start with this prefix.
{string} pattern The pattern that was passed into the constructor
New
UrlMatcherobject