Close #1544 Document slashesDenoteHost flag in url.parse
authorisaacs <i@izs.me>
Wed, 17 Aug 2011 20:13:56 +0000 (13:13 -0700)
committerRyan Dahl <ry@tinyclouds.org>
Thu, 18 Aug 2011 01:47:48 +0000 (18:47 -0700)
doc/api/url.markdown

index 5f9b31f..150f7d4 100644 (file)
@@ -42,11 +42,17 @@ string will not be in the parsed object. Examples are shown for the URL
 
 The following methods are provided by the URL module:
 
-### url.parse(urlStr, parseQueryString=false)
+### url.parse(urlStr, parseQueryString=false, slashesDenoteHost=false)
 
-Take a URL string, and return an object.  Pass `true` as the second argument to also parse
+Take a URL string, and return an object.
+
+Pass `true` as the second argument to also parse
 the query string using the `querystring` module.
 
+Pass `true` as the third argument to treat `//foo/bar` as
+`{ host: 'foo', pathname: '/bar' }` rather than
+`{ pathname: '//foo/bar' }`.
+
 ### url.format(urlObj)
 
 Take a parsed URL object, and return a formatted URL string.