Skip to content

Commit d024027

Browse files
docs($urlMatcherFactory): document param type
1 parent 8ce69d9 commit d024027

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
"karma-phantomjs-launcher": "~0.1.0",
6262
"load-grunt-tasks": "~0.4.0",
6363
"grunt-conventional-changelog": "~1.1.0",
64-
"grunt-ngdocs": "~0.1.7"
64+
"grunt-ngdocs": "~0.2.6"
6565
},
6666
"main": "release/angular-ui-router.js"
6767
}

src/urlMatcherFactory.js

+6-4
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ var $$UMFP; // reference to $UrlMatcherFactoryProvider
1717
* * `':'` name - colon placeholder
1818
* * `'*'` name - catch-all placeholder
1919
* * `'{' name '}'` - curly placeholder
20-
* * `'{' name ':' regexp '}'` - curly placeholder with regexp. Should the regexp itself contain
21-
* curly braces, they must be in matched pairs or escaped with a backslash.
20+
* * `'{' name ':' regexp|type '}'` - curly placeholder with regexp or type name. Should the
21+
* regexp itself contain curly braces, they must be in matched pairs or escaped with a backslash.
2222
*
2323
* Parameter names may contain only word characters (latin letters, digits, and underscore) and
2424
* must be unique within the pattern (across both path and search parameters). For colon
@@ -39,6 +39,8 @@ var $$UMFP; // reference to $UrlMatcherFactoryProvider
3939
* * `'/files/{path:.*}'` - Matches any URL starting with '/files/' and captures the rest of the
4040
* path into the parameter 'path'.
4141
* * `'/files/*path'` - ditto.
42+
* * `'/calendar/{start:date}'` - Matches "/calendar/2014-11-12" (because the pattern defined
43+
* in the built-in `date` Type matches `2014-11-12`) and provides a Date object in $stateParams.start
4244
*
4345
* @param {string} pattern The pattern to compile into a matcher.
4446
* @param {Object} config A configuration object hash:
@@ -602,7 +604,7 @@ function $UrlMatcherFactory() {
602604
* Defines whether URL matching should be case sensitive (the default behavior), or not.
603605
*
604606
* @param {boolean} value `false` to match URL in a case sensitive manner; otherwise `true`;
605-
* @return the current value of caseInsensitive
607+
* @returns {boolean} the current value of caseInsensitive
606608
*/
607609
this.caseInsensitive = function(value) {
608610
if (isDefined(value))
@@ -619,7 +621,7 @@ function $UrlMatcherFactory() {
619621
* Defines whether URLs should match trailing slashes, or not (the default behavior).
620622
*
621623
* @param {boolean=} value `false` to match trailing slashes in URLs, otherwise `true`.
622-
* @return the current value of strictMode
624+
* @returns {boolean} the current value of strictMode
623625
*/
624626
this.strictMode = function(value) {
625627
if (isDefined(value))

0 commit comments

Comments
 (0)