1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: state url decoding behavior

Browse Source 
Explicitly states the fact that no decoding is performed on the url
path or pathname or the query string by default in the URL module.

Fixes: https://github.com/nodejs/io.js/issues/1538
PR-URL: https://github.com/nodejs/io.js/pull/1731
Reviewed-By: Roman Reiss <me@silverwind.io>
This commit is contained in:
Josh Gummersall 2015-05-18 21:35:48 -07:00 committed by Roman Reiss
parent 1eec5f091a
commit a74c2c9458
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/api/url.markdown
View File

@ -41,7 +41,8 @@ string will not be in the parsed object. Examples are shown for the URL
Example: `'8080'`
* `pathname`: The path section of the URL, that comes after the host and
before the query, including the initial slash if present.
before the query, including the initial slash if present. No decoding is
performed.
Example: `'/p/a/t/h'`
@ -50,7 +51,7 @@ string will not be in the parsed object. Examples are shown for the URL
Example: `'?query=string'`
* `path`: Concatenation of `pathname` and `search`.
* `path`: Concatenation of `pathname` and `search`. No decoding is performed.
Example: `'/p/a/t/h?query=string'`
@ -72,7 +73,8 @@ Take a URL string, and return an object.
Pass `true` as the second argument to also parse the query string using the
`querystring` module. If `true` then the `query` property will always be
assigned an object, and the `search` property will always be a (possibly
empty) string. Defaults to `false`.
empty) string. If `false` then the `query` property will not be parsed or
decoded. Defaults to `false`.
Pass `true` as the third argument to treat `//foo/bar` as
`{ host: 'foo', pathname: '/bar' }` rather than